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

Gets a list of work teams that you have defined in a region. The list may be empty if no work team satisfies the filter specified in the NameContains parameter.

{
   "[MaxResults](#SageMaker-ListWorkteams-request-MaxResults)": number,
   "[NameContains](#SageMaker-ListWorkteams-request-NameContains)": "string",
   "[NextToken](#SageMaker-ListWorkteams-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListWorkteams-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListWorkteams-request-SortOrder)": "string"
}

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

The request accepts the following data in JSON format.

** MaxResults ** The maximum number of work teams to return in each page of the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No

** NameContains ** A string in the work team’s name. This filter returns only work teams whose name contains the specified string.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*
Required: No

** NextToken ** If the result of the previous ListWorkteams request was truncated, the response includes a NextToken. To retrieve the next set of labeling jobs, use the token in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*
Required: No

** SortBy ** The field to sort results by. The default is CreationTime.
Type: String
Valid Values:Name | CreateDate
Required: No

** SortOrder ** The sort order for results. The default is Ascending.
Type: String
Valid Values:Ascending | Descending
Required: No

{
   "[NextToken](#SageMaker-ListWorkteams-response-NextToken)": "string",
   "[Workteams](#SageMaker-ListWorkteams-response-Workteams)": [ 
      { 
         "[CreateDate](API_Workteam.md#SageMaker-Type-Workteam-CreateDate)": number,
         "[Description](API_Workteam.md#SageMaker-Type-Workteam-Description)": "string",
         "[LastUpdatedDate](API_Workteam.md#SageMaker-Type-Workteam-LastUpdatedDate)": number,
         "[MemberDefinitions](API_Workteam.md#SageMaker-Type-Workteam-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](API_Workteam.md#SageMaker-Type-Workteam-NotificationConfiguration)": { 
            "[NotificationTopicArn](API_NotificationConfiguration.md#SageMaker-Type-NotificationConfiguration-NotificationTopicArn)": "string"
         },
         "[ProductListingIds](API_Workteam.md#SageMaker-Type-Workteam-ProductListingIds)": [ "string" ],
         "[SubDomain](API_Workteam.md#SageMaker-Type-Workteam-SubDomain)": "string",
         "[WorkteamArn](API_Workteam.md#SageMaker-Type-Workteam-WorkteamArn)": "string",
         "[WorkteamName](API_Workteam.md#SageMaker-Type-Workteam-WorkteamName)": "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.

** NextToken ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of work teams, use it in the subsequent request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*

** Workteams ** An array of Workteam objects, each describing a work team.
Type: Array of Workteam objects

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

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