ListWorkteams
Gets a list of private 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.
Request Syntax
{
"MaxResults": number,
"NameContains": "string",
"NextToken": "string",
"SortBy": "string",
"SortOrder": "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.
- 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]){0,62}Required: No
- NextToken
-
If the result of the previous
ListWorkteamsrequest was truncated, the response includes aNextToken. 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 | CreateDateRequired: No
- SortOrder
-
The sort order for results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
Response Syntax
{
"NextToken": "string",
"Workteams": [
{
"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.
- 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
Workteamobjects, each describing a work team.Type: Array of Workteam objects
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
