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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Synopsis

data UpdateWorkteam = UpdateWorkteam' {
- notificationConfiguration :: Maybe NotificationConfiguration
- memberDefinitions :: Maybe (NonEmpty MemberDefinition)
- description :: Maybe Text
- workteamName :: Text
}
newUpdateWorkteam :: Text -> UpdateWorkteam
updateWorkteam_notificationConfiguration :: Lens' UpdateWorkteam (Maybe NotificationConfiguration)
updateWorkteam_memberDefinitions :: Lens' UpdateWorkteam (Maybe (NonEmpty MemberDefinition))
updateWorkteam_description :: Lens' UpdateWorkteam (Maybe Text)
updateWorkteam_workteamName :: Lens' UpdateWorkteam Text
data UpdateWorkteamResponse = UpdateWorkteamResponse' {
- httpStatus :: Int
- workteam :: Workteam
}
newUpdateWorkteamResponse :: Int -> Workteam -> UpdateWorkteamResponse
updateWorkteamResponse_httpStatus :: Lens' UpdateWorkteamResponse Int
updateWorkteamResponse_workteam :: Lens' UpdateWorkteamResponse Workteam

Creating a Request

data UpdateWorkteam Source #

See: newUpdateWorkteam smart constructor.

Constructors

UpdateWorkteam'

Fields

notificationConfiguration :: Maybe NotificationConfiguration
Configures SNS topic notifications for available or expiring work items
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.
description :: Maybe Text
An updated description for the work team.
workteamName :: Text
The name of the work team to update.

Instances

Instances details

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

newUpdateWorkteam Source #

Arguments

:: Text	`$sel:workteamName: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:

$sel:notificationConfiguration:UpdateWorkteam', updateWorkteam_notificationConfiguration - Configures SNS topic notifications for available or expiring work items

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

$sel:description:UpdateWorkteam', updateWorkteam_description - An updated description for the work team.

$sel:workteamName:UpdateWorkteam', updateWorkteam_workteamName - The name of the work team to update.

Request Lenses

updateWorkteam_notificationConfiguration :: Lens' UpdateWorkteam (Maybe NotificationConfiguration) Source #

Configures SNS topic notifications for available or expiring work items

updateWorkteam_memberDefinitions :: Lens' UpdateWorkteam (Maybe (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. 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_description :: Lens' UpdateWorkteam (Maybe Text) Source #

An updated description for the work team.

updateWorkteam_workteamName :: Lens' UpdateWorkteam Text Source #

The name of the work team to update.

Destructuring the Response

data UpdateWorkteamResponse Source #

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

Instances details

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

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

The response's http status code.

updateWorkteamResponse_workteam :: Lens' UpdateWorkteamResponse Workteam Source #

A Workteam object that describes the updated work team.