Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

CreateWorkteam

Creates a new work team for labeling your data. A work team is defined by one or more Amazon Cognito user pools. You must first create the user pools before you can create a work team.

You cannot create more than 25 work teams in an account and region.

{
   "[Description](#SageMaker-CreateWorkteam-request-Description)": "string",
   "[MemberDefinitions](#SageMaker-CreateWorkteam-request-MemberDefinitions)": [ 
      { 
         "[CognitoMemberDefinition](API_MemberDefinition.md#SageMaker-Type-MemberDefinition-CognitoMemberDefinition)": { 
            "[ClientId](API_CognitoMemberDefinition.md#SageMaker-Type-CognitoMemberDefinition-ClientId)": "string",
            "[UserGroup](API_CognitoMemberDefinition.md#SageMaker-Type-CognitoMemberDefinition-UserGroup)": "string",
            "[UserPool](API_CognitoMemberDefinition.md#SageMaker-Type-CognitoMemberDefinition-UserPool)": "string"
         }
      }
   ],
   "[NotificationConfiguration](#SageMaker-CreateWorkteam-request-NotificationConfiguration)": { 
      "[NotificationTopicArn](API_NotificationConfiguration.md#SageMaker-Type-NotificationConfiguration-NotificationTopicArn)": "string"
   },
   "[Tags](#SageMaker-CreateWorkteam-request-Tags)": [ 
      { 
         "[Key](API_Tag.md#SageMaker-Type-Tag-Key)": "string",
         "[Value](API_Tag.md#SageMaker-Type-Tag-Value)": "string"
      }
   ],
   "[WorkteamName](#SageMaker-CreateWorkteam-request-WorkteamName)": "string"
}

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

The request accepts the following data in JSON format.

** Description ** A description of the work team.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern: .+
Required: Yes

** MemberDefinitions ** A list of MemberDefinition objects that contains objects that identify the Amazon Cognito user pool that makes up the work team. For more information, see Amazon Cognito User Pools.
All of the CognitoMemberDefinition objects that make up the member definition must have the same ClientId and UserPool values.
Type: Array of MemberDefinition objects
Array Members: Minimum number of 1 item. Maximum number of 10 items.
Required: Yes

** NotificationConfiguration ** Configures notification of workers regarding available or expiring work items.
Type: NotificationConfiguration object
Required: No

** Tags ** Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No

** WorkteamName ** The name of the work team. Use this name to identify the work team.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: Yes

{
   "[WorkteamArn](#SageMaker-CreateWorkteam-response-WorkteamArn)": "string"
}

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

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

** WorkteamArn ** The Amazon Resource Name (ARN) of the work team. You can use this ARN to identify the work team.
Type: String
Length Constraints: Maximum length of 256.
Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workteam/.*

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

ResourceInUse
Resource being accessed is in use.
HTTP Status Code: 400

ResourceLimitExceeded
You have exceeded an Amazon SageMaker resource limit. For example, you might have too many training jobs created.
HTTP Status Code: 400

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2