You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::SageMaker::Types::UpdateWorkteamRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SageMaker::Types::UpdateWorkteamRequest
- Defined in:
- (unknown)
Overview
When passing UpdateWorkteamRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
workteam_name: "WorkteamName", # required
member_definitions: [
{
cognito_member_definition: {
user_pool: "CognitoUserPool", # required
user_group: "CognitoUserGroup", # required
client_id: "ClientId", # required
},
oidc_member_definition: {
groups: ["Group"], # required
},
},
],
description: "String200",
notification_configuration: {
notification_topic_arn: "NotificationTopicArn",
},
}
Instance Attribute Summary collapse
-
#description ⇒ String
An updated description for the work team.
-
#member_definitions ⇒ Array<Types::MemberDefinition>
A list of
MemberDefinition
objects that contains objects that identify the workers that make up the work team. -
#notification_configuration ⇒ Types::NotificationConfiguration
Configures SNS topic notifications for available or expiring work items.
-
#workteam_name ⇒ String
The name of the work team to update.
Instance Attribute Details
#description ⇒ String
An updated description for the work team.
#member_definitions ⇒ Array<Types::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 Adding 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.
#notification_configuration ⇒ Types::NotificationConfiguration
Configures SNS topic notifications for available or expiring work items
#workteam_name ⇒ String
The name of the work team to update.