Amazon SageMaker
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

UpdateWorkteam

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

Request Syntax

{ "Description": "string", "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" } } ], "NotificationConfiguration": { "NotificationTopicArn": "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 contain the updated work team members.

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

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])*

Required: Yes

Response Syntax

{ "Workteam": { "CreateDate": number, "Description": "string", "LastUpdatedDate": number, "MemberDefinitions": [ { "CognitoMemberDefinition": { "ClientId": "string", "UserGroup": "string", "UserPool": "string" } } ], "NotificationConfiguration": { "NotificationTopicArn": "string" }, "ProductListingIds": [ "string" ], "SubDomain": "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 Amazon SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: