DescribeLabelingJob
Gets information about a labeling job.
Request Syntax
{
"LabelingJobName": "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.
- LabelingJobName
-
The name of the labeling job to return information for.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}Required: Yes
Response Syntax
{
"CreationTime": number,
"FailureReason": "string",
"HumanTaskConfig": {
"AnnotationConsolidationConfig": {
"AnnotationConsolidationLambdaArn": "string"
},
"MaxConcurrentTaskCount": number,
"NumberOfHumanWorkersPerDataObject": number,
"PreHumanTaskLambdaArn": "string",
"PublicWorkforceTaskPrice": {
"AmountInUsd": {
"Cents": number,
"Dollars": number,
"TenthFractionsOfACent": number
}
},
"TaskAvailabilityLifetimeInSeconds": number,
"TaskDescription": "string",
"TaskKeywords": [ "string" ],
"TaskTimeLimitInSeconds": number,
"TaskTitle": "string",
"UiConfig": {
"HumanTaskUiArn": "string",
"UiTemplateS3Uri": "string"
},
"WorkteamArn": "string"
},
"InputConfig": {
"DataAttributes": {
"ContentClassifiers": [ "string" ]
},
"DataSource": {
"S3DataSource": {
"ManifestS3Uri": "string"
},
"SnsDataSource": {
"SnsTopicArn": "string"
}
}
},
"JobReferenceCode": "string",
"LabelAttributeName": "string",
"LabelCategoryConfigS3Uri": "string",
"LabelCounters": {
"FailedNonRetryableError": number,
"HumanLabeled": number,
"MachineLabeled": number,
"TotalLabeled": number,
"Unlabeled": number
},
"LabelingJobAlgorithmsConfig": {
"InitialActiveLearningModelArn": "string",
"LabelingJobAlgorithmSpecificationArn": "string",
"LabelingJobResourceConfig": {
"VolumeKmsKeyId": "string",
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "string" ]
}
}
},
"LabelingJobArn": "string",
"LabelingJobName": "string",
"LabelingJobOutput": {
"FinalActiveLearningModelArn": "string",
"OutputDatasetS3Uri": "string"
},
"LabelingJobStatus": "string",
"LastModifiedTime": number,
"OutputConfig": {
"KmsKeyId": "string",
"S3OutputPath": "string",
"SnsTopicArn": "string"
},
"RoleArn": "string",
"StoppingConditions": {
"MaxHumanLabeledObjectCount": number,
"MaxPercentageOfInputDatasetLabeled": number
},
"Tags": [
{
"Key": "string",
"Value": "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.
- CreationTime
-
The date and time that the labeling job was created.
Type: Timestamp
- FailureReason
-
If the job failed, the reason that it failed.
Type: String
Length Constraints: Maximum length of 1024.
- HumanTaskConfig
-
Configuration information required for human workers to complete a labeling task.
Type: HumanTaskConfig object
- InputConfig
-
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.
Type: LabelingJobInputConfig object
- JobReferenceCode
-
A unique identifier for work done as part of a labeling job.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
.+ - LabelAttributeName
-
The attribute used as the label in the output manifest file.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 127.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,126} - LabelCategoryConfigS3Uri
-
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"}]}Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^(https|s3)://([^/]+)/?(.*)$ -
- 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.
Type: LabelCounters object
- LabelingJobAlgorithmsConfig
-
Configuration information for automated data labeling.
Type: LabelingJobAlgorithmsConfig object
- LabelingJobArn
-
The Amazon Resource Name (ARN) of the labeling job.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:labeling-job/.* - LabelingJobName
-
The name assigned to the labeling job when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62} - LabelingJobOutput
-
The location of the output produced by the labeling job.
Type: LabelingJobOutput object
- LabelingJobStatus
-
The processing status of the labeling job.
Type: String
Valid Values:
Initializing | InProgress | Completed | Failed | Stopping | Stopped - LastModifiedTime
-
The date and time that the labeling job was last updated.
Type: Timestamp
- OutputConfig
-
The location of the job's output data and the AWS Key Management Service key ID for the key used to encrypt the output data, if any.
Type: LabelingJobOutputConfig object
- RoleArn
-
The Amazon Resource Name (ARN) that SageMaker assumes to perform tasks on your behalf during data labeling.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$ - StoppingConditions
-
A set of conditions for stopping a labeling job. If any of the conditions are met, the job is automatically stopped.
Type: LabelingJobStoppingConditions object
- Tags
-
An array of key-value pairs. You can use tags to categorize your AWS resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging AWS Resources.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
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 AWS SDKs, see the following:
