SageMaker / Client / update_workteam

update_workteam#

SageMaker.Client.update_workteam(**kwargs)#

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

Request Syntax

response = client.update_workteam(
    WorkteamName='string',
    MemberDefinitions=[
        {
            'CognitoMemberDefinition': {
                'UserPool': 'string',
                'UserGroup': 'string',
                'ClientId': 'string'
            },
            'OidcMemberDefinition': {
                'Groups': [
                    'string',
                ]
            }
        },
    ],
    Description='string',
    NotificationConfiguration={
        'NotificationTopicArn': 'string'
    }
)

Parameters:

WorkteamName (string) –
[REQUIRED]

The name of the work team to update.
MemberDefinitions (list) –
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.
- (dict) –
  
  Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
  - CognitoMemberDefinition (dict) –
    
    The Amazon Cognito user group that is part of the work team.
    - UserPool (string) – [REQUIRED]
      
      An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
    - UserGroup (string) – [REQUIRED]
      
      An identifier for a user group.
    - ClientId (string) – [REQUIRED]
      
      An identifier for an application client. You must create the app client ID using Amazon Cognito.
  - OidcMemberDefinition (dict) –
    
    A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
    - Groups (list) – [REQUIRED]
      
      A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
      - (string) –
Description (string) – An updated description for the work team.
NotificationConfiguration (dict) –
Configures SNS topic notifications for available or expiring work items
- NotificationTopicArn (string) –
  
  The ARN for the Amazon SNS topic to which notifications should be published.

Return type:

dict

Returns:

Response Syntax

{
    'Workteam': {
        'WorkteamName': 'string',
        'MemberDefinitions': [
            {
                'CognitoMemberDefinition': {
                    'UserPool': 'string',
                    'UserGroup': 'string',
                    'ClientId': 'string'
                },
                'OidcMemberDefinition': {
                    'Groups': [
                        'string',
                    ]
                }
            },
        ],
        'WorkteamArn': 'string',
        'WorkforceArn': 'string',
        'ProductListingIds': [
            'string',
        ],
        'Description': 'string',
        'SubDomain': 'string',
        'CreateDate': datetime(2015, 1, 1),
        'LastUpdatedDate': datetime(2015, 1, 1),
        'NotificationConfiguration': {
            'NotificationTopicArn': 'string'
        }
    }
}

Response Structure

(dict) –
- Workteam (dict) –
  
  A Workteam object that describes the updated work team.
  - WorkteamName (string) –
    
    The name of the work team.
  - MemberDefinitions (list) –
    
    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.
    - (dict) –
      
      Defines an Amazon Cognito or your own OIDC IdP user group that is part of a work team.
      - CognitoMemberDefinition (dict) –
        
        The Amazon Cognito user group that is part of the work team.
        
        UserPool (string) –
        
        An identifier for a user pool. The user pool must be in the same region as the service that you are calling.
        
        UserGroup (string) –
        
        An identifier for a user group.
        
        ClientId (string) –
        
        An identifier for an application client. You must create the app client ID using Amazon Cognito.
      - OidcMemberDefinition (dict) –
        
        A list user groups that exist in your OIDC Identity Provider (IdP). One to ten groups can be used to create a single private work team. When you add a user group to the list of Groups, you can add that user group to one or more private work teams. If you add a user group to a private work team, all workers in that user group are added to the work team.
        
        Groups (list) –
        
        A list of comma seperated strings that identifies user groups in your OIDC IdP. Each user group is made up of a group of private workers.
        
        (string) –
  - WorkteamArn (string) –
    
    The Amazon Resource Name (ARN) that identifies the work team.
  - WorkforceArn (string) –
    
    The Amazon Resource Name (ARN) of the workforce.
  - ProductListingIds (list) –
    
    The Amazon Marketplace identifier for a vendor’s work team.
    - (string) –
  - Description (string) –
    
    A description of the work team.
  - SubDomain (string) –
    
    The URI of the labeling job’s user interface. Workers open this URI to start labeling your data objects.
  - CreateDate (datetime) –
    
    The date and time that the work team was created (timestamp).
  - LastUpdatedDate (datetime) –
    
    The date and time that the work team was last updated (timestamp).
  - NotificationConfiguration (dict) –
    
    Configures SNS notifications of available or expiring work items for work teams.
    - NotificationTopicArn (string) –
      
      The ARN for the Amazon SNS topic to which notifications should be published.

Exceptions

SageMaker.Client.exceptions.ResourceLimitExceeded