Gets a list of labeling jobs.
Request Syntax
{
"CreationTimeAfter": number,
"CreationTimeBefore": number,
"LastModifiedTimeAfter": number,
"LastModifiedTimeBefore": number,
"MaxResults": number,
"NameContains": "string",
"NextToken": "string",
"SortBy": "string",
"SortOrder": "string",
"StatusEquals": "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
- LastModifiedTimeAfter
-
A filter that returns only labeling jobs modified after the specified time (timestamp).
Type: Timestamp
Required: No
- LastModifiedTimeBefore
-
A filter that returns only labeling jobs modified before the specified time (timestamp).
Type: Timestamp
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
- NameContains
-
A string in the labeling job name. This filter returns only labeling jobs whose name contains the specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern:
[a-zA-Z0-9\-]+Required: No
- NextToken
-
If the result of the previous
ListLabelingJobsrequest 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 | CreationTime | StatusRequired: No
- SortOrder
-
The sort order for results. The default is
Ascending.Type: String
Valid Values:
Ascending | DescendingRequired: No
- StatusEquals
-
A filter that retrieves only labeling jobs with a specific status.
Type: String
Valid Values:
Initializing | InProgress | Completed | Failed | Stopping | StoppedRequired: No
Response Syntax
{
"LabelingJobSummaryList": [
{
"AnnotationConsolidationLambdaArn": "string",
"CreationTime": number,
"FailureReason": "string",
"InputConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"DataSource": {
"S3DataSource": {
"ManifestS3Uri": "string"
},
"SnsDataSource": {
"SnsTopicArn": "string"
}
}
},
"LabelCounters": {
"FailedNonRetryableError": number,
"HumanLabeled": number,
"MachineLabeled": number,
"TotalLabeled": number,
"Unlabeled": number
},
"LabelingJobArn": "string",
"LabelingJobName": "string",
"LabelingJobOutput": {
"FinalActiveLearningModelArn": "string",
"OutputDatasetS3Uri": "string"
},
"LabelingJobStatus": "string",
"LastModifiedTime": number,
"PreHumanTaskLambdaArn": "string",
"WorkteamArn": "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 LabelingJobSummary 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.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
