v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Gets information about a labeling job.

post/#X-Amz-Target=SageMaker.DescribeLabelingJob

Headers

X-Amz-Target'SageMaker.DescribeLabelingJob' required

Request body

LabelingJobNamestring required

The name of the labeling job to return information for.

Response

Success

LabelingJobStatus'Initializing' | 'InProgress' | 'Completed' | 'Failed' | 'Stopping' | 'Stopped' required

The processing status of the labeling job.

FailureReasonstring

If the job failed, the reason that it failed.

CreationTimestring date-time required

The date and time that the labeling job was created.

LastModifiedTimestring date-time required

The date and time that the labeling job was last updated.

JobReferenceCodestring required

A unique identifier for work done as part of a labeling job.

LabelingJobNamestring required

The name assigned to the labeling job when it was created.

LabelingJobArnstring required

The Amazon Resource Name (ARN) of the labeling job.

LabelAttributeNamestring

The attribute used as the label in the output manifest file.

RoleArnstring required

The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.

LabelCategoryConfigS3Uristring
<p>The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:</p> <ul> <li> <p>Semantic segmentation labeling jobs using automated labeling: 20 labels</p> </li> <li> <p>Box bounding labeling jobs (all): 10 labels</p> </li> </ul> <p>The file is a JSON structure in the following format:</p> <p> <code>{</code> </p> <p> <code> "document-version": "2018-11-28"</code> </p> <p> <code> "labels": [</code> </p> <p> <code> {</code> </p> <p> <code> "label": "<i>label 1</i>"</code> </p> <p> <code> },</code> </p> <p> <code> {</code> </p> <p> <code> "label": "<i>label 2</i>"</code> </p> <p> <code> },</code> </p> <p> <code> ...</code> </p> <p> <code> {</code> </p> <p> <code> "label": "<i>label n</i>"</code> </p> <p> <code> }</code> </p> <p> <code> ]</code> </p> <p> <code>}</code> </p>