ListLabelingJobsForWorkteam
Gets a list of labeling jobs assigned to a specified work team.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"JobReferenceCodeContains": "string",
"MaxResults": number,
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"WorkteamArn": "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.
- CreationTimeAfter
-
A filter that returns only labeling jobs created after the specified time (timestamp).
Type: Timestamp
Required: No
- CreationTimeBefore
-
A filter that returns only labeling jobs created before the specified time (timestamp).
Type: Timestamp
Required: No
- JobReferenceCodeContains
-
A filter the limits jobs to only the ones whose job reference code contains the specified string.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
.+Required: No
- MaxResults
-
The maximum number of labeling jobs to return in each page of the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
If the result of the previous
ListLabelingJobsForWorkteamrequest 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:
CreationTimeRequired: No
- SortOrder
-
The sort order for results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- WorkteamArn
-
The Amazon Resource Name (ARN) of the work team for which you want to see labeling jobs for.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:workteam/.*Required: Yes
Response Syntax
{
"LabelingJobSummaryList": [
{
"CreationTime": number,
"JobReferenceCode": "string",
"LabelCounters": {
"HumanLabeled": number,
"PendingHuman": number,
"Total": number
},
"LabelingJobName": "string",
"NumberOfHumanWorkersPerDataObject": number,
"WorkRequesterAccountId": "string"
}
],
"NextToken": "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.
- LabelingJobSummaryList
-
An array of
LabelingJobSummaryobjects, each describing a labeling job.Type: Array of LabelingJobForWorkteamSummary objects
- NextToken
-
If the response is truncated, SageMaker returns this token. To retrieve the next set of labeling jobs, use it in the subsequent request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: