Amazonka.SageMaker.CreateWorkteam

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

Creating a Request

data CreateWorkteam

See: newCreateWorkteam smart constructor.

Constructors

CreateWorkteam'

Fields

• notificationConfiguration :: Maybe NotificationConfiguration

  Configures notification of workers regarding available or expiring work items.

• tags :: Maybe [Tag]

  An array of key-value pairs.

  For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

• workforceName :: Maybe Text

  The name of the workforce.

• workteamName :: Text

  The name of the work team. Use this name to identify the work team.

• memberDefinitions :: NonEmpty MemberDefinition

  A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

  Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

  For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

  For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

• description :: Text

  A description of the work team.

Instances

ToJSON CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

toJSON :: CreateWorkteam -> Value

toEncoding :: CreateWorkteam -> Encoding

toJSONList :: [CreateWorkteam] -> Value

toEncodingList :: [CreateWorkteam] -> Encoding

ToHeaders CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

toHeaders :: CreateWorkteam -> [Header]

ToPath CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

toPath :: CreateWorkteam -> ByteString

ToQuery CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

toQuery :: CreateWorkteam -> QueryString

AWSRequest CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Associated Types

type AWSResponse CreateWorkteam

Methods

request :: (Service -> Service) -> CreateWorkteam -> Request CreateWorkteam

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateWorkteam -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkteam)))

Generic CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Associated Types

type Rep CreateWorkteam :: Type -> Type

Methods

from :: CreateWorkteam -> Rep CreateWorkteam x

to :: Rep CreateWorkteam x -> CreateWorkteam

Read CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

readsPrec :: Int -> ReadS CreateWorkteam

readList :: ReadS [CreateWorkteam]

readPrec :: ReadPrec CreateWorkteam

readListPrec :: ReadPrec [CreateWorkteam]

Show CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

showsPrec :: Int -> CreateWorkteam -> ShowS

show :: CreateWorkteam -> String

showList :: [CreateWorkteam] -> ShowS

NFData CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

rnf :: CreateWorkteam -> ()

Eq CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

(==) :: CreateWorkteam -> CreateWorkteam -> Bool

(/=) :: CreateWorkteam -> CreateWorkteam -> Bool

Hashable CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

hashWithSalt :: Int -> CreateWorkteam -> Int

hash :: CreateWorkteam -> Int

type AWSResponse CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

type AWSResponse CreateWorkteam = CreateWorkteamResponse

type Rep CreateWorkteam

Defined in Amazonka.SageMaker.CreateWorkteam

type Rep CreateWorkteam = D1 ('MetaData "CreateWorkteam" "Amazonka.SageMaker.CreateWorkteam" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateWorkteam'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "notificationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationConfiguration)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "workforceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "workteamName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "memberDefinitions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty MemberDefinition)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateWorkteam

Arguments

:: Text

CreateWorkteam

-> NonEmpty MemberDefinition

CreateWorkteam

-> Text

CreateWorkteam

-> CreateWorkteam

Create a value of CreateWorkteam 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:

CreateWorkteam, createWorkteam_notificationConfiguration - Configures notification of workers regarding available or expiring work items.

CreateWorkteam, createWorkteam_tags - An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

CreateWorkteam, createWorkteam_workforceName - The name of the workforce.

CreateWorkteam, createWorkteam_workteamName - The name of the work team. Use this name to identify the work team.

CreateWorkteam, createWorkteam_memberDefinitions - A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

CreateWorkteam, createWorkteam_description - A description of the work team.

Request Lenses

createWorkteam_notificationConfiguration :: Lens' CreateWorkteam (Maybe NotificationConfiguration)

Configures notification of workers regarding available or expiring work items.

createWorkteam_tags :: Lens' CreateWorkteam (Maybe [Tag])

An array of key-value pairs.

For more information, see Resource Tag and Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.

createWorkteam_workforceName :: Lens' CreateWorkteam (Maybe Text)

The name of the workforce.

createWorkteam_workteamName :: Lens' CreateWorkteam Text

The name of the work team. Use this name to identify the work team.

createWorkteam_memberDefinitions :: Lens' CreateWorkteam (NonEmpty MemberDefinition)

A list of MemberDefinition objects that contains objects that identify the workers that make up the work team.

Workforces can be created using Amazon Cognito or your own OIDC Identity Provider (IdP). For private workforces created using Amazon Cognito use CognitoMemberDefinition. For workforces created using your own OIDC identity provider (IdP) use OidcMemberDefinition. Do not provide input for both of these parameters in a single request.

For workforces created using Amazon Cognito, private work teams correspond to Amazon Cognito user groups within the user pool used to create a workforce. All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values. To add a Amazon Cognito user group to an existing worker pool, see groups to a User Pool. For more information about user pools, see Amazon Cognito User Pools.

For workforces created using your own OIDC IdP, specify the user groups that you want to include in your private work team in OidcMemberDefinition by listing those groups in Groups.

createWorkteam_description :: Lens' CreateWorkteam Text

A description of the work team.

Destructuring the Response

data CreateWorkteamResponse

See: newCreateWorkteamResponse smart constructor.

Constructors

CreateWorkteamResponse'

Fields

• workteamArn :: Maybe Text

  The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateWorkteamResponse

Defined in Amazonka.SageMaker.CreateWorkteam

Associated Types

type Rep CreateWorkteamResponse :: Type -> Type

Methods

from :: CreateWorkteamResponse -> Rep CreateWorkteamResponse x

to :: Rep CreateWorkteamResponse x -> CreateWorkteamResponse

Read CreateWorkteamResponse

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

readsPrec :: Int -> ReadS CreateWorkteamResponse

readList :: ReadS [CreateWorkteamResponse]

readPrec :: ReadPrec CreateWorkteamResponse

readListPrec :: ReadPrec [CreateWorkteamResponse]

Show CreateWorkteamResponse

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

showsPrec :: Int -> CreateWorkteamResponse -> ShowS

show :: CreateWorkteamResponse -> String

showList :: [CreateWorkteamResponse] -> ShowS

NFData CreateWorkteamResponse

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

rnf :: CreateWorkteamResponse -> ()

Eq CreateWorkteamResponse

Defined in Amazonka.SageMaker.CreateWorkteam

Methods

(==) :: CreateWorkteamResponse -> CreateWorkteamResponse -> Bool

(/=) :: CreateWorkteamResponse -> CreateWorkteamResponse -> Bool

type Rep CreateWorkteamResponse

Defined in Amazonka.SageMaker.CreateWorkteam

type Rep CreateWorkteamResponse = D1 ('MetaData "CreateWorkteamResponse" "Amazonka.SageMaker.CreateWorkteam" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "CreateWorkteamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "workteamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateWorkteamResponse

Arguments

:: Int

$sel:httpStatus:CreateWorkteamResponse'

-> CreateWorkteamResponse

Create a value of CreateWorkteamResponse 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:

CreateWorkteamResponse, createWorkteamResponse_workteamArn - The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

$sel:httpStatus:CreateWorkteamResponse', createWorkteamResponse_httpStatus - The response's http status code.

Response Lenses

createWorkteamResponse_workteamArn :: Lens' CreateWorkteamResponse (Maybe Text)

The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.

createWorkteamResponse_httpStatus :: Lens' CreateWorkteamResponse Int

The response's http status code.