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

ListLabelingJobs

Gets a list of labeling jobs.

{
   "[CreationTimeAfter](#SageMaker-ListLabelingJobs-request-CreationTimeAfter)": number,
   "[CreationTimeBefore](#SageMaker-ListLabelingJobs-request-CreationTimeBefore)": number,
   "[LastModifiedTimeAfter](#SageMaker-ListLabelingJobs-request-LastModifiedTimeAfter)": number,
   "[LastModifiedTimeBefore](#SageMaker-ListLabelingJobs-request-LastModifiedTimeBefore)": number,
   "[MaxResults](#SageMaker-ListLabelingJobs-request-MaxResults)": number,
   "[NameContains](#SageMaker-ListLabelingJobs-request-NameContains)": "string",
   "[NextToken](#SageMaker-ListLabelingJobs-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListLabelingJobs-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListLabelingJobs-request-SortOrder)": "string",
   "[StatusEquals](#SageMaker-ListLabelingJobs-request-StatusEquals)": "string"
}

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 ListLabelingJobs 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 | CreationTime | Status
Required: No

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

** StatusEquals ** A filter that retrieves only labeling jobs with a specific status.
Type: String
Valid Values:InProgress | Completed | Failed | Stopping | Stopped
Required: No

{
   "[LabelingJobSummaryList](#SageMaker-ListLabelingJobs-response-LabelingJobSummaryList)": [ 
      { 
         "[AnnotationConsolidationLambdaArn](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-AnnotationConsolidationLambdaArn)": "string",
         "[CreationTime](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-CreationTime)": number,
         "[FailureReason](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-FailureReason)": "string",
         "[InputConfig](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-InputConfig)": { 
            "[DataAttributes](API_LabelingJobInputConfig.md#SageMaker-Type-LabelingJobInputConfig-DataAttributes)": { 
               "[ContentClassifiers](API_LabelingJobDataAttributes.md#SageMaker-Type-LabelingJobDataAttributes-ContentClassifiers)": [ "string" ]
            },
            "[DataSource](API_LabelingJobInputConfig.md#SageMaker-Type-LabelingJobInputConfig-DataSource)": { 
               "[S3DataSource](API_LabelingJobDataSource.md#SageMaker-Type-LabelingJobDataSource-S3DataSource)": { 
                  "[ManifestS3Uri](API_LabelingJobS3DataSource.md#SageMaker-Type-LabelingJobS3DataSource-ManifestS3Uri)": "string"
               }
            }
         },
         "[LabelCounters](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-LabelCounters)": { 
            "[FailedNonRetryableError](API_LabelCounters.md#SageMaker-Type-LabelCounters-FailedNonRetryableError)": number,
            "[HumanLabeled](API_LabelCounters.md#SageMaker-Type-LabelCounters-HumanLabeled)": number,
            "[MachineLabeled](API_LabelCounters.md#SageMaker-Type-LabelCounters-MachineLabeled)": number,
            "[TotalLabeled](API_LabelCounters.md#SageMaker-Type-LabelCounters-TotalLabeled)": number,
            "[Unlabeled](API_LabelCounters.md#SageMaker-Type-LabelCounters-Unlabeled)": number
         },
         "[LabelingJobArn](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-LabelingJobArn)": "string",
         "[LabelingJobName](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-LabelingJobName)": "string",
         "[LabelingJobOutput](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-LabelingJobOutput)": { 
            "[FinalActiveLearningModelArn](API_LabelingJobOutput.md#SageMaker-Type-LabelingJobOutput-FinalActiveLearningModelArn)": "string",
            "[OutputDatasetS3Uri](API_LabelingJobOutput.md#SageMaker-Type-LabelingJobOutput-OutputDatasetS3Uri)": "string"
         },
         "[LabelingJobStatus](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-LabelingJobStatus)": "string",
         "[LastModifiedTime](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-LastModifiedTime)": number,
         "[PreHumanTaskLambdaArn](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-PreHumanTaskLambdaArn)": "string",
         "[WorkteamArn](API_LabelingJobSummary.md#SageMaker-Type-LabelingJobSummary-WorkteamArn)": "string"
      }
   ],
   "[NextToken](#SageMaker-ListLabelingJobs-response-NextToken)": "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.

** LabelingJobSummaryList ** An array of LabelingJobSummary objects, each describing a labeling job.
Type: Array of LabelingJobSummary objects

** NextToken ** If the response is truncated, Amazon 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: .*

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