DescribeCompilationJob
Returns information about a model compilation job.
To create a model compilation job, use CreateCompilationJob. To get information about multiple model compilation jobs, use ListCompilationJobs.
Request Syntax
{
"CompilationJobName": "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.
- CompilationJobName
-
The name of the model compilation job that you want information about.
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
{
"CompilationEndTime": number,
"CompilationJobArn": "string",
"CompilationJobName": "string",
"CompilationJobStatus": "string",
"CompilationStartTime": number,
"CreationTime": number,
"DerivedInformation": {
"DerivedDataInputConfig": "string"
},
"FailureReason": "string",
"InferenceImage": "string",
"InputConfig": {
"DataInputConfig": "string",
"Framework": "string",
"FrameworkVersion": "string",
"S3Uri": "string"
},
"LastModifiedTime": number,
"ModelArtifacts": {
"S3ModelArtifacts": "string"
},
"ModelDigests": {
"ArtifactDigest": "string"
},
"ModelPackageVersionArn": "string",
"OutputConfig": {
"CompilerOptions": "string",
"KmsKeyId": "string",
"S3OutputLocation": "string",
"TargetDevice": "string",
"TargetPlatform": {
"Accelerator": "string",
"Arch": "string",
"Os": "string"
}
},
"RoleArn": "string",
"StoppingCondition": {
"MaxPendingTimeInSeconds": number,
"MaxRuntimeInSeconds": number,
"MaxWaitTimeInSeconds": number
},
"VpcConfig": {
"SecurityGroupIds": [ "string" ],
"Subnets": [ "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.
- CompilationEndTime
-
The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.
Type: Timestamp
- CompilationJobArn
-
The Amazon Resource Name (ARN) of the model compilation job.
Type: String
Length Constraints: Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:compilation-job/.* - CompilationJobName
-
The name of the model compilation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 63.
Pattern:
^[a-zA-Z0-9](-*[a-zA-Z0-9]){0,62}$ - CompilationJobStatus
-
The status of the model compilation job.
Type: String
Valid Values:
INPROGRESS | COMPLETED | FAILED | STARTING | STOPPING | STOPPED - CompilationStartTime
-
The time when the model compilation job started the
CompilationJobinstances.You are billed for the time between this timestamp and the timestamp in the
CompilationEndTimefield. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.Type: Timestamp
- CreationTime
-
The time that the model compilation job was created.
Type: Timestamp
- DerivedInformation
-
Information that SageMaker Neo automatically derived about the model.
Type: DerivedInformation object
- FailureReason
-
If a model compilation job failed, the reason it failed.
Type: String
Length Constraints: Maximum length of 1024.
- InferenceImage
-
The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.
Type: String
Length Constraints: Maximum length of 256.
- InputConfig
-
Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
Type: InputConfig object
- LastModifiedTime
-
The time that the status of the model compilation job was last modified.
Type: Timestamp
- ModelArtifacts
-
Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
Type: ModelArtifacts object
- ModelDigests
-
Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
Type: ModelDigests object
- ModelPackageVersionArn
-
The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^arn:aws(-cn|-us-gov|-iso-f)?:sagemaker:[a-z0-9\-]{9,16}:[0-9]{12}:model-package/[\S]{1,2048}$ - OutputConfig
-
Information about the output location for the compiled model and the target device that the model runs on.
Type: OutputConfig object
- RoleArn
-
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
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+=,.@\-_/]+$ - StoppingCondition
-
Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
Type: StoppingCondition object
- VpcConfig
-
A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
Type: NeoVpcConfig object
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:
