Amazonka.SageMaker.UpdateWorkteam

Updates an existing work team with new member definitions or description.

Creating a Request

data UpdateWorkteam

See: newUpdateWorkteam smart constructor.

Constructors

UpdateWorkteam'

Fields

• description :: Maybe Text

  An updated description for the work team.

• memberDefinitions :: Maybe (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. You should 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. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

• notificationConfiguration :: Maybe NotificationConfiguration

  Configures SNS topic notifications for available or expiring work items

• workteamName :: Text

  The name of the work team to update.

Instances

ToJSON UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

toJSON :: UpdateWorkteam -> Value

toEncoding :: UpdateWorkteam -> Encoding

toJSONList :: [UpdateWorkteam] -> Value

toEncodingList :: [UpdateWorkteam] -> Encoding

ToHeaders UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

toHeaders :: UpdateWorkteam -> [Header]

ToPath UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

toPath :: UpdateWorkteam -> ByteString

ToQuery UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

toQuery :: UpdateWorkteam -> QueryString

AWSRequest UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Associated Types

type AWSResponse UpdateWorkteam

Methods

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

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

Generic UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Associated Types

type Rep UpdateWorkteam :: Type -> Type

Methods

from :: UpdateWorkteam -> Rep UpdateWorkteam x

to :: Rep UpdateWorkteam x -> UpdateWorkteam

Read UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

readsPrec :: Int -> ReadS UpdateWorkteam

readList :: ReadS [UpdateWorkteam]

readPrec :: ReadPrec UpdateWorkteam

readListPrec :: ReadPrec [UpdateWorkteam]

Show UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

showsPrec :: Int -> UpdateWorkteam -> ShowS

show :: UpdateWorkteam -> String

showList :: [UpdateWorkteam] -> ShowS

NFData UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

rnf :: UpdateWorkteam -> ()

Eq UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

(==) :: UpdateWorkteam -> UpdateWorkteam -> Bool

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

Hashable UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

hashWithSalt :: Int -> UpdateWorkteam -> Int

hash :: UpdateWorkteam -> Int

type AWSResponse UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

type AWSResponse UpdateWorkteam = UpdateWorkteamResponse

type Rep UpdateWorkteam

Defined in Amazonka.SageMaker.UpdateWorkteam

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

newUpdateWorkteam

Arguments

:: Text

UpdateWorkteam

-> UpdateWorkteam

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

UpdateWorkteam, updateWorkteam_description - An updated description for the work team.

UpdateWorkteam, updateWorkteam_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. You should 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. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

UpdateWorkteam, updateWorkteam_notificationConfiguration - Configures SNS topic notifications for available or expiring work items

UpdateWorkteam, updateWorkteam_workteamName - The name of the work team to update.

Request Lenses

updateWorkteam_description :: Lens' UpdateWorkteam (Maybe Text)

An updated description for the work team.

updateWorkteam_memberDefinitions :: Lens' UpdateWorkteam (Maybe (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. You should 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. Be aware that user groups that are already in the work team must also be listed in Groups when you make this request to remain on the work team. If you do not include these user groups, they will no longer be associated with the work team you update.

updateWorkteam_notificationConfiguration :: Lens' UpdateWorkteam (Maybe NotificationConfiguration)

Configures SNS topic notifications for available or expiring work items

updateWorkteam_workteamName :: Lens' UpdateWorkteam Text

The name of the work team to update.

Destructuring the Response

data UpdateWorkteamResponse

See: newUpdateWorkteamResponse smart constructor.

Constructors

UpdateWorkteamResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• workteam :: Workteam

  A Workteam object that describes the updated work team.

Instances

Generic UpdateWorkteamResponse

Defined in Amazonka.SageMaker.UpdateWorkteam

Associated Types

type Rep UpdateWorkteamResponse :: Type -> Type

Methods

from :: UpdateWorkteamResponse -> Rep UpdateWorkteamResponse x

to :: Rep UpdateWorkteamResponse x -> UpdateWorkteamResponse

Read UpdateWorkteamResponse

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

readsPrec :: Int -> ReadS UpdateWorkteamResponse

readList :: ReadS [UpdateWorkteamResponse]

readPrec :: ReadPrec UpdateWorkteamResponse

readListPrec :: ReadPrec [UpdateWorkteamResponse]

Show UpdateWorkteamResponse

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

showsPrec :: Int -> UpdateWorkteamResponse -> ShowS

show :: UpdateWorkteamResponse -> String

showList :: [UpdateWorkteamResponse] -> ShowS

NFData UpdateWorkteamResponse

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

rnf :: UpdateWorkteamResponse -> ()

Eq UpdateWorkteamResponse

Defined in Amazonka.SageMaker.UpdateWorkteam

Methods

(==) :: UpdateWorkteamResponse -> UpdateWorkteamResponse -> Bool

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

type Rep UpdateWorkteamResponse

Defined in Amazonka.SageMaker.UpdateWorkteam

type Rep UpdateWorkteamResponse = D1 ('MetaData "UpdateWorkteamResponse" "Amazonka.SageMaker.UpdateWorkteam" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "UpdateWorkteamResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "workteam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Workteam)))

newUpdateWorkteamResponse

Arguments

:: Int

$sel:httpStatus:UpdateWorkteamResponse'

-> Workteam

$sel:workteam:UpdateWorkteamResponse'

-> UpdateWorkteamResponse

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

$sel:workteam:UpdateWorkteamResponse', updateWorkteamResponse_workteam - A Workteam object that describes the updated work team.

Response Lenses

updateWorkteamResponse_httpStatus :: Lens' UpdateWorkteamResponse Int

The response's http status code.

updateWorkteamResponse_workteam :: Lens' UpdateWorkteamResponse Workteam

A Workteam object that describes the updated work team.