Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateWorkteam

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

Request Syntax


{
   "Description": "string",
   "MemberDefinitions": [ 
      { 
         "CognitoMemberDefinition": { 
            "ClientId": "string",
            "UserGroup": "string",
            "UserPool": "string"
         },
         "OidcMemberDefinition": { 
            "Groups": [ "string" ]
         }
      }
   ],
   "NotificationConfiguration": { 
      "NotificationTopicArn": "string"
   },
   "WorkerAccessConfiguration": { 
      "S3Presign": { 
         "IamPolicyConstraints": { 
            "SourceIp": "string",
            "VpcSourceIp": "string"
         }
      }
   },
   "WorkteamName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

An updated description for the work team.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: .+

Required: No

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

Type: Array of MemberDefinition objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: No

NotificationConfiguration

Configures SNS topic notifications for available or expiring work items

Type: NotificationConfiguration object

Required: No

WorkerAccessConfiguration

Use this optional parameter to constrain access to an Amazon S3 resource based on the IP address using supported IAM global condition keys. The Amazon S3 resource is accessed in the worker portal using a Amazon S3 presigned URL.

Type: WorkerAccessConfiguration object

Required: No

WorkteamName

The name of the work team to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}

Required: Yes

Response Syntax


{
   "Workteam": { 
      "CreateDate": number,
      "Description": "string",
      "LastUpdatedDate": number,
      "MemberDefinitions": [ 
         { 
            "CognitoMemberDefinition": { 
               "ClientId": "string",
               "UserGroup": "string",
               "UserPool": "string"
            },
            "OidcMemberDefinition": { 
               "Groups": [ "string" ]
            }
         }
      ],
      "NotificationConfiguration": { 
         "NotificationTopicArn": "string"
      },
      "ProductListingIds": [ "string" ],
      "SubDomain": "string",
      "WorkerAccessConfiguration": { 
         "S3Presign": { 
            "IamPolicyConstraints": { 
               "SourceIp": "string",
               "VpcSourceIp": "string"
            }
         }
      },
      "WorkforceArn": "string",
      "WorkteamArn": "string",
      "WorkteamName": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Workteam

A Workteam object that describes the updated work team.

Type: Workteam object

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400