Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SageMaker.CreateWorkforce

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this operation to create a workforce. This operation will return an error if a workforce already exists in the Amazon Web Services Region that you specify. You can only create one workforce in each Amazon Web Services Region per Amazon Web Services account.

If you want to create a new workforce in an Amazon Web Services Region where a workforce already exists, use the API operation to delete the existing workforce and then use CreateWorkforce to create a new workforce.

To create a private workforce using Amazon Cognito, you must specify a Cognito user pool in CognitoConfig. You can also create an Amazon Cognito workforce using the Amazon SageMaker console. For more information, see Create a Private Workforce (Amazon Cognito).

To create a private workforce using your own OIDC Identity Provider (IdP), specify your IdP configuration in OidcConfig. Your OIDC IdP must support groups because groups are used by Ground Truth and Amazon A2I to create work teams. For more information, see Create a Private Workforce (OIDC IdP).

Synopsis

data CreateWorkforce = CreateWorkforce' {
- sourceIpConfig :: Maybe SourceIpConfig
- cognitoConfig :: Maybe CognitoConfig
- oidcConfig :: Maybe OidcConfig
- tags :: Maybe [Tag]
- workforceName :: Text
}
newCreateWorkforce :: Text -> CreateWorkforce
createWorkforce_sourceIpConfig :: Lens' CreateWorkforce (Maybe SourceIpConfig)
createWorkforce_cognitoConfig :: Lens' CreateWorkforce (Maybe CognitoConfig)
createWorkforce_oidcConfig :: Lens' CreateWorkforce (Maybe OidcConfig)
createWorkforce_tags :: Lens' CreateWorkforce (Maybe [Tag])
createWorkforce_workforceName :: Lens' CreateWorkforce Text
data CreateWorkforceResponse = CreateWorkforceResponse' {
- httpStatus :: Int
- workforceArn :: Text
}
newCreateWorkforceResponse :: Int -> Text -> CreateWorkforceResponse
createWorkforceResponse_httpStatus :: Lens' CreateWorkforceResponse Int
createWorkforceResponse_workforceArn :: Lens' CreateWorkforceResponse Text

Creating a Request

data CreateWorkforce Source #

See: newCreateWorkforce smart constructor.

Constructors

CreateWorkforce'

Fields

sourceIpConfig :: Maybe SourceIpConfig
cognitoConfig :: Maybe CognitoConfig
Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.
Do not use OidcConfig if you specify values for CognitoConfig.
oidcConfig :: Maybe OidcConfig
Use this parameter to configure a private workforce using your own OIDC Identity Provider.
Do not use CognitoConfig if you specify values for OidcConfig.
tags :: Maybe [Tag]
An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.
workforceName :: Text
The name of the private workforce.

Instances

Instances details

Eq CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods (==) :: CreateWorkforce -> CreateWorkforce -> Bool # (/=) :: CreateWorkforce -> CreateWorkforce -> Bool #
Show CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods showsPrec :: Int -> CreateWorkforce -> ShowS # show :: CreateWorkforce -> String # showList :: [CreateWorkforce] -> ShowS #
Generic CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Associated Types type Rep CreateWorkforce :: Type -> Type # Methods from :: CreateWorkforce -> Rep CreateWorkforce x # to :: Rep CreateWorkforce x -> CreateWorkforce #
NFData CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods rnf :: CreateWorkforce -> () #
Hashable CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods hashWithSalt :: Int -> CreateWorkforce -> Int # hash :: CreateWorkforce -> Int #
ToJSON CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods toJSON :: CreateWorkforce -> Value # toEncoding :: CreateWorkforce -> Encoding # toJSONList :: [CreateWorkforce] -> Value # toEncodingList :: [CreateWorkforce] -> Encoding #
AWSRequest CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Associated Types type AWSResponse CreateWorkforce # Methods request :: CreateWorkforce -> Request CreateWorkforce # response :: MonadResource m => Logger -> Service -> Proxy CreateWorkforce -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkforce))) #
ToHeaders CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods toHeaders :: CreateWorkforce -> [Header] #
ToPath CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods toPath :: CreateWorkforce -> ByteString #
ToQuery CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods toQuery :: CreateWorkforce -> QueryString #
type Rep CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce type Rep CreateWorkforce = D1 ('MetaData "CreateWorkforce" "Amazonka.SageMaker.CreateWorkforce" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateWorkforce'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sourceIpConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SourceIpConfig)) :: S1 ('MetaSel ('Just "cognitoConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CognitoConfig))) :: (S1 ('MetaSel ('Just "oidcConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OidcConfig)) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "workforceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateWorkforce Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce type AWSResponse CreateWorkforce = CreateWorkforceResponse

newCreateWorkforce Source #

Arguments

:: Text	`$sel:workforceName:CreateWorkforce'`
-> CreateWorkforce

Create a value of CreateWorkforce 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:sourceIpConfig:CreateWorkforce', createWorkforce_sourceIpConfig - Undocumented member.

$sel:cognitoConfig:CreateWorkforce', createWorkforce_cognitoConfig - Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

$sel:oidcConfig:CreateWorkforce', createWorkforce_oidcConfig - Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

$sel:tags:CreateWorkforce', createWorkforce_tags - An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

$sel:workforceName:CreateWorkforce', createWorkforce_workforceName - The name of the private workforce.

Request Lenses

createWorkforce_sourceIpConfig :: Lens' CreateWorkforce (Maybe SourceIpConfig) Source #

Undocumented member.

createWorkforce_cognitoConfig :: Lens' CreateWorkforce (Maybe CognitoConfig) Source #

Use this parameter to configure an Amazon Cognito private workforce. A single Cognito workforce is created using and corresponds to a single Amazon Cognito user pool.

Do not use OidcConfig if you specify values for CognitoConfig.

createWorkforce_oidcConfig :: Lens' CreateWorkforce (Maybe OidcConfig) Source #

Use this parameter to configure a private workforce using your own OIDC Identity Provider.

Do not use CognitoConfig if you specify values for OidcConfig.

createWorkforce_tags :: Lens' CreateWorkforce (Maybe [Tag]) Source #

An array of key-value pairs that contain metadata to help you categorize and organize our workforce. Each tag consists of a key and a value, both of which you define.

createWorkforce_workforceName :: Lens' CreateWorkforce Text Source #

The name of the private workforce.

Destructuring the Response

data CreateWorkforceResponse Source #

See: newCreateWorkforceResponse smart constructor.

Constructors

CreateWorkforceResponse'
Fields httpStatus :: Int The response's http status code. workforceArn :: Text The Amazon Resource Name (ARN) of the workforce.

Instances

Instances details

Eq CreateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods (==) :: CreateWorkforceResponse -> CreateWorkforceResponse -> Bool # (/=) :: CreateWorkforceResponse -> CreateWorkforceResponse -> Bool #
Read CreateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods readsPrec :: Int -> ReadS CreateWorkforceResponse # readList :: ReadS [CreateWorkforceResponse] # readPrec :: ReadPrec CreateWorkforceResponse # readListPrec :: ReadPrec [CreateWorkforceResponse] #
Show CreateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods showsPrec :: Int -> CreateWorkforceResponse -> ShowS # show :: CreateWorkforceResponse -> String # showList :: [CreateWorkforceResponse] -> ShowS #
Generic CreateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Associated Types type Rep CreateWorkforceResponse :: Type -> Type # Methods from :: CreateWorkforceResponse -> Rep CreateWorkforceResponse x # to :: Rep CreateWorkforceResponse x -> CreateWorkforceResponse #
NFData CreateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce Methods rnf :: CreateWorkforceResponse -> () #
type Rep CreateWorkforceResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkforce type Rep CreateWorkforceResponse = D1 ('MetaData "CreateWorkforceResponse" "Amazonka.SageMaker.CreateWorkforce" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateWorkforceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workforceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateWorkforceResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateWorkforceResponse'`
-> Text	`$sel:workforceArn:CreateWorkforceResponse'`
-> CreateWorkforceResponse

Create a value of CreateWorkforceResponse 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:CreateWorkforceResponse', createWorkforceResponse_httpStatus - The response's http status code.

$sel:workforceArn:CreateWorkforceResponse', createWorkforceResponse_workforceArn - The Amazon Resource Name (ARN) of the workforce.

Response Lenses

createWorkforceResponse_httpStatus :: Lens' CreateWorkforceResponse Int Source #

The response's http status code.

createWorkforceResponse_workforceArn :: Lens' CreateWorkforceResponse Text Source #

The Amazon Resource Name (ARN) of the workforce.