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.CreateWorkteam

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data CreateWorkteam = CreateWorkteam' {
- notificationConfiguration :: Maybe NotificationConfiguration
- workforceName :: Maybe Text
- tags :: Maybe [Tag]
- workteamName :: Text
- memberDefinitions :: NonEmpty MemberDefinition
- description :: Text
}
newCreateWorkteam :: Text -> NonEmpty MemberDefinition -> Text -> CreateWorkteam
createWorkteam_notificationConfiguration :: Lens' CreateWorkteam (Maybe NotificationConfiguration)
createWorkteam_workforceName :: Lens' CreateWorkteam (Maybe Text)
createWorkteam_tags :: Lens' CreateWorkteam (Maybe [Tag])
createWorkteam_workteamName :: Lens' CreateWorkteam Text
createWorkteam_memberDefinitions :: Lens' CreateWorkteam (NonEmpty MemberDefinition)
createWorkteam_description :: Lens' CreateWorkteam Text
data CreateWorkteamResponse = CreateWorkteamResponse' {
- workteamArn :: Maybe Text
- httpStatus :: Int
}
newCreateWorkteamResponse :: Int -> CreateWorkteamResponse
createWorkteamResponse_workteamArn :: Lens' CreateWorkteamResponse (Maybe Text)
createWorkteamResponse_httpStatus :: Lens' CreateWorkteamResponse Int

Creating a Request

data CreateWorkteam Source #

See: newCreateWorkteam smart constructor.

Constructors

CreateWorkteam'

Fields

notificationConfiguration :: Maybe NotificationConfiguration
Configures notification of workers regarding available or expiring work items.
workforceName :: Maybe Text
The name of the workforce.
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.
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

Instances details

Eq CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods (==) :: CreateWorkteam -> CreateWorkteam -> Bool # (/=) :: CreateWorkteam -> CreateWorkteam -> Bool #
Read CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods readsPrec :: Int -> ReadS CreateWorkteam # readList :: ReadS [CreateWorkteam] # readPrec :: ReadPrec CreateWorkteam # readListPrec :: ReadPrec [CreateWorkteam] #
Show CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods showsPrec :: Int -> CreateWorkteam -> ShowS # show :: CreateWorkteam -> String # showList :: [CreateWorkteam] -> ShowS #
Generic CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Associated Types type Rep CreateWorkteam :: Type -> Type # Methods from :: CreateWorkteam -> Rep CreateWorkteam x # to :: Rep CreateWorkteam x -> CreateWorkteam #
NFData CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods rnf :: CreateWorkteam -> () #
Hashable CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods hashWithSalt :: Int -> CreateWorkteam -> Int # hash :: CreateWorkteam -> Int #
ToJSON CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods toJSON :: CreateWorkteam -> Value # toEncoding :: CreateWorkteam -> Encoding # toJSONList :: [CreateWorkteam] -> Value # toEncodingList :: [CreateWorkteam] -> Encoding #
AWSRequest CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Associated Types type AWSResponse CreateWorkteam # Methods request :: CreateWorkteam -> Request CreateWorkteam # response :: MonadResource m => Logger -> Service -> Proxy CreateWorkteam -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateWorkteam))) #
ToHeaders CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods toHeaders :: CreateWorkteam -> [Header] #
ToPath CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods toPath :: CreateWorkteam -> ByteString #
ToQuery CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods toQuery :: CreateWorkteam -> QueryString #
type Rep CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam type Rep CreateWorkteam = D1 ('MetaData "CreateWorkteam" "Amazonka.SageMaker.CreateWorkteam" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" 'False) (C1 ('MetaCons "CreateWorkteam'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "notificationConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationConfiguration)) :: (S1 ('MetaSel ('Just "workforceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :: (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)))))
type AWSResponse CreateWorkteam Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam type AWSResponse CreateWorkteam = CreateWorkteamResponse

newCreateWorkteam Source #

Arguments

:: Text	`$sel:workteamName:CreateWorkteam'`
-> NonEmpty MemberDefinition	`$sel:memberDefinitions:CreateWorkteam'`
-> Text	`$sel:description: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:

$sel:notificationConfiguration:CreateWorkteam', createWorkteam_notificationConfiguration - Configures notification of workers regarding available or expiring work items.

$sel:workforceName:CreateWorkteam', createWorkteam_workforceName - The name of the workforce.

$sel:tags: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.

$sel:workteamName:CreateWorkteam', createWorkteam_workteamName - The name of the work team. Use this name to identify the work team.

$sel:memberDefinitions: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.

$sel:description:CreateWorkteam', createWorkteam_description - A description of the work team.

Request Lenses

createWorkteam_notificationConfiguration :: Lens' CreateWorkteam (Maybe NotificationConfiguration) Source #

Configures notification of workers regarding available or expiring work items.

createWorkteam_workforceName :: Lens' CreateWorkteam (Maybe Text) Source #

The name of the workforce.

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

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_workteamName :: Lens' CreateWorkteam Text Source #

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

createWorkteam_memberDefinitions :: Lens' CreateWorkteam (NonEmpty MemberDefinition) Source #

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 Source #

A description of the work team.

Destructuring the Response

data CreateWorkteamResponse Source #

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

Instances details

Eq CreateWorkteamResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods (==) :: CreateWorkteamResponse -> CreateWorkteamResponse -> Bool # (/=) :: CreateWorkteamResponse -> CreateWorkteamResponse -> Bool #
Read CreateWorkteamResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods readsPrec :: Int -> ReadS CreateWorkteamResponse # readList :: ReadS [CreateWorkteamResponse] # readPrec :: ReadPrec CreateWorkteamResponse # readListPrec :: ReadPrec [CreateWorkteamResponse] #
Show CreateWorkteamResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods showsPrec :: Int -> CreateWorkteamResponse -> ShowS # show :: CreateWorkteamResponse -> String # showList :: [CreateWorkteamResponse] -> ShowS #
Generic CreateWorkteamResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Associated Types type Rep CreateWorkteamResponse :: Type -> Type # Methods from :: CreateWorkteamResponse -> Rep CreateWorkteamResponse x # to :: Rep CreateWorkteamResponse x -> CreateWorkteamResponse #
NFData CreateWorkteamResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam Methods rnf :: CreateWorkteamResponse -> () #
type Rep CreateWorkteamResponse Source #
Instance details Defined in Amazonka.SageMaker.CreateWorkteam type Rep CreateWorkteamResponse = D1 ('MetaData "CreateWorkteamResponse" "Amazonka.SageMaker.CreateWorkteam" "libZSservicesZSamazonka-sagemakerZSamazonka-sagemaker" '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 Source #

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:

$sel:workteamArn: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) Source #

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

createWorkteamResponse_httpStatus :: Lens' CreateWorkteamResponse Int Source #

The response's http status code.