libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.SageMaker.DescribeWorkforce

Description

Lists private workforce information, including workforce name, Amazon Resource Name (ARN), and, if applicable, allowed IP address ranges (CIDRs). Allowable IP address ranges are the IP addresses that workers can use to access tasks.

This operation applies only to private workforces.

Synopsis

Creating a Request

data DescribeWorkforce Source #

See: newDescribeWorkforce smart constructor.

Constructors

DescribeWorkforce' 

Fields

  • workforceName :: Text

    The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Instances

Instances details
Eq DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Read DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Show DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Generic DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Associated Types

type Rep DescribeWorkforce :: Type -> Type #

NFData DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Methods

rnf :: DescribeWorkforce -> () #

Hashable DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

ToJSON DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

AWSRequest DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Associated Types

type AWSResponse DescribeWorkforce #

ToHeaders DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

ToPath DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

ToQuery DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

type Rep DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

type Rep DescribeWorkforce = D1 ('MetaData "DescribeWorkforce" "Amazonka.SageMaker.DescribeWorkforce" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeWorkforce'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workforceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeWorkforce Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

newDescribeWorkforce Source #

Create a value of DescribeWorkforce with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:workforceName:DescribeWorkforce', describeWorkforce_workforceName - The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Request Lenses

describeWorkforce_workforceName :: Lens' DescribeWorkforce Text Source #

The name of the private workforce whose access you want to restrict. WorkforceName is automatically set to default when a workforce is created and cannot be modified.

Destructuring the Response

data DescribeWorkforceResponse Source #

See: newDescribeWorkforceResponse smart constructor.

Constructors

DescribeWorkforceResponse' 

Fields

  • httpStatus :: Int

    The response's http status code.

  • workforce :: Workforce

    A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

Instances

Instances details
Eq DescribeWorkforceResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Read DescribeWorkforceResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Show DescribeWorkforceResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Generic DescribeWorkforceResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

Associated Types

type Rep DescribeWorkforceResponse :: Type -> Type #

NFData DescribeWorkforceResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

type Rep DescribeWorkforceResponse Source # 
Instance details

Defined in Amazonka.SageMaker.DescribeWorkforce

type Rep DescribeWorkforceResponse = D1 ('MetaData "DescribeWorkforceResponse" "Amazonka.SageMaker.DescribeWorkforce" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "DescribeWorkforceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workforce") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Workforce)))

newDescribeWorkforceResponse Source #

Create a value of DescribeWorkforceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:DescribeWorkforceResponse', describeWorkforceResponse_httpStatus - The response's http status code.

$sel:workforce:DescribeWorkforceResponse', describeWorkforceResponse_workforce - A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

Response Lenses

describeWorkforceResponse_workforce :: Lens' DescribeWorkforceResponse Workforce Source #

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each Amazon Web Services Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.