| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.SageMaker.UpdateWorkteam
Description
Updates an existing work team with new member definitions or description.
Synopsis
- data UpdateWorkteam = UpdateWorkteam' {}
- newUpdateWorkteam :: Text -> UpdateWorkteam
- updateWorkteam_description :: Lens' UpdateWorkteam (Maybe Text)
- updateWorkteam_memberDefinitions :: Lens' UpdateWorkteam (Maybe (NonEmpty MemberDefinition))
- updateWorkteam_notificationConfiguration :: Lens' UpdateWorkteam (Maybe NotificationConfiguration)
- 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
| |
Instances
Arguments
| :: Text | |
| -> 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) Source #
An updated description for the work team.
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_notificationConfiguration :: Lens' UpdateWorkteam (Maybe NotificationConfiguration) Source #
Configures SNS topic notifications for available or expiring work items
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
| |
Instances
newUpdateWorkteamResponse Source #
Arguments
| :: Int | |
| -> Workteam | |
| -> 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.