Skip to content

DescribeLabelingJobResponse

Source code in docs_src/capo_sagemaker/types/describe_labeling_job_response.py
class DescribeLabelingJobResponse(TypedDict, closed=True):
    labeling_job_status: NotRequired[
        "capo_sagemaker.types.labeling_job_status.LabelingJobStatus"
    ]
    """<p>The processing status of the labeling job. </p>"""
    label_counters: NotRequired["capo_sagemaker.types.label_counters.LabelCounters"]
    """<p>Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled. </p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If the job failed, the reason that it failed. </p>"""
    creation_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The date and time that the labeling job was created.</p>"""
    last_modified_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The date and time that the labeling job was last updated.</p>"""
    job_reference_code: NotRequired[
        "capo_sagemaker.types.job_reference_code.JobReferenceCode"
    ]
    """<p>A unique identifier for work done as part of a labeling job.</p>"""
    labeling_job_name: NotRequired[
        "capo_sagemaker.types.labeling_job_name.LabelingJobName"
    ]
    """<p>The name assigned to the labeling job when it was created.</p>"""
    labeling_job_arn: NotRequired[
        "capo_sagemaker.types.labeling_job_arn.LabelingJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the labeling job.</p>"""
    label_attribute_name: NotRequired[
        "capo_sagemaker.types.label_attribute_name.LabelAttributeName"
    ]
    """<p>The attribute used as the label in the output manifest file.</p>"""
    input_config: NotRequired[
        "capo_sagemaker.types.labeling_job_input_config.LabelingJobInputConfig"
    ]
    """<p>Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.</p>"""
    output_config: NotRequired[
        "capo_sagemaker.types.labeling_job_output_config.LabelingJobOutputConfig"
    ]
    """<p>The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.</p>"""
    label_category_config_s3_uri: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<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>"""
    stopping_conditions: NotRequired[
        "capo_sagemaker.types.labeling_job_stopping_conditions.LabelingJobStoppingConditions"
    ]
    """<p>A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.</p>"""
    labeling_job_algorithms_config: NotRequired[
        "capo_sagemaker.types.labeling_job_algorithms_config.LabelingJobAlgorithmsConfig"
    ]
    """<p>Configuration information for automated data labeling.</p>"""
    human_task_config: NotRequired[
        "capo_sagemaker.types.human_task_config.HumanTaskConfig"
    ]
    """<p>Configuration information required for human workers to complete a labeling task.</p>"""
    tags: NotRequired["capo_sagemaker.types.tag_list.TagList"]
    """<p>An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a>.</p>"""
    labeling_job_output: NotRequired[
        "capo_sagemaker.types.labeling_job_output.LabelingJobOutput"
    ]
    """<p>The location of the output produced by the labeling job.</p>"""

creation_time instance-attribute

creation_time: NotRequired[Timestamp]

The date and time that the labeling job was created.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If the job failed, the reason that it failed.

human_task_config instance-attribute

human_task_config: NotRequired[HumanTaskConfig]

Configuration information required for human workers to complete a labeling task.

input_config instance-attribute

input_config: NotRequired[LabelingJobInputConfig]

Input configuration information for the labeling job, such as the Amazon S3 location of the data objects and the location of the manifest file that describes the data objects.

job_reference_code instance-attribute

job_reference_code: NotRequired[JobReferenceCode]

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

label_attribute_name instance-attribute

label_attribute_name: NotRequired[LabelAttributeName]

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

label_category_config_s3_uri instance-attribute

label_category_config_s3_uri: NotRequired[S3Uri]

The S3 location of the JSON file that defines the categories used to label data objects. Please note the following label-category limits:

  • Semantic segmentation labeling jobs using automated labeling: 20 labels

  • Box bounding labeling jobs (all): 10 labels

The file is a JSON structure in the following format:

{

"document-version": "2018-11-28"

"labels": [

{

"label": "label 1"

},

{

"label": "label 2"

},

...

{

"label": "label n"

}

]

}

label_counters instance-attribute

label_counters: NotRequired[LabelCounters]

Provides a breakdown of the number of data objects labeled by humans, the number of objects labeled by machine, the number of objects than couldn't be labeled, and the total number of objects labeled.

labeling_job_algorithms_config instance-attribute

labeling_job_algorithms_config: NotRequired[LabelingJobAlgorithmsConfig]

Configuration information for automated data labeling.

labeling_job_arn instance-attribute

labeling_job_arn: NotRequired[LabelingJobArn]

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

labeling_job_name instance-attribute

labeling_job_name: NotRequired[LabelingJobName]

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

labeling_job_output instance-attribute

labeling_job_output: NotRequired[LabelingJobOutput]

The location of the output produced by the labeling job.

labeling_job_status instance-attribute

labeling_job_status: NotRequired[LabelingJobStatus]

The processing status of the labeling job.

last_modified_time instance-attribute

last_modified_time: NotRequired[Timestamp]

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

output_config instance-attribute

output_config: NotRequired[LabelingJobOutputConfig]

The location of the job's output data and the Amazon Web Services Key Management Service key ID for the key used to encrypt the output data, if any.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

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

stopping_conditions instance-attribute

stopping_conditions: NotRequired[LabelingJobStoppingConditions]

A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.

tags instance-attribute

tags: NotRequired[TagList]

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.