Skip to content

DescribeCompilationJobResponse

Source code in docs_src/capo_sagemaker/types/describe_compilation_job_response.py
class DescribeCompilationJobResponse(TypedDict, closed=True):
    compilation_job_name: NotRequired["capo_sagemaker.types.entity_name.EntityName"]
    """<p>The name of the model compilation job.</p>"""
    compilation_job_arn: NotRequired[
        "capo_sagemaker.types.compilation_job_arn.CompilationJobArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the model compilation job.</p>"""
    compilation_job_status: NotRequired[
        "capo_sagemaker.types.compilation_job_status.CompilationJobStatus"
    ]
    """<p>The status of the model compilation job.</p>"""
    compilation_start_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>The time when the model compilation job started the <code>CompilationJob</code> instances. </p> <p>You are billed for the time between this timestamp and the timestamp in the <code>CompilationEndTime</code> field. 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. </p>"""
    compilation_end_time: NotRequired["capo_sagemaker.types.timestamp.Timestamp"]
    """<p>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 AI detected that the job failed. </p>"""
    stopping_condition: NotRequired[
        "capo_sagemaker.types.stopping_condition.StoppingCondition"
    ]
    """<p>Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.</p>"""
    inference_image: NotRequired["capo_sagemaker.types.inference_image.InferenceImage"]
    """<p>The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.</p>"""
    model_package_version_arn: NotRequired[
        "capo_sagemaker.types.model_package_arn.ModelPackageArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.</p>"""
    creation_time: NotRequired["capo_sagemaker.types.creation_time.CreationTime"]
    """<p>The time that the model compilation job was created.</p>"""
    last_modified_time: NotRequired[
        "capo_sagemaker.types.last_modified_time.LastModifiedTime"
    ]
    """<p>The time that the status of the model compilation job was last modified.</p>"""
    failure_reason: NotRequired["capo_sagemaker.types.failure_reason.FailureReason"]
    """<p>If a model compilation job failed, the reason it failed. </p>"""
    model_artifacts: NotRequired["capo_sagemaker.types.model_artifacts.ModelArtifacts"]
    """<p>Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.</p>"""
    model_digests: NotRequired["capo_sagemaker.types.model_digests.ModelDigests"]
    """<p>Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.</p>"""
    role_arn: NotRequired["capo_sagemaker.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.</p>"""
    input_config: NotRequired["capo_sagemaker.types.input_config.InputConfig"]
    """<p>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.</p>"""
    output_config: NotRequired["capo_sagemaker.types.output_config.OutputConfig"]
    """<p>Information about the output location for the compiled model and the target device that the model runs on.</p>"""
    vpc_config: NotRequired["capo_sagemaker.types.neo_vpc_config.NeoVpcConfig"]
    """<p>A <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VpcConfig.html">VpcConfig</a> 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 <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/neo-vpc.html">Protect Compilation Jobs by Using an Amazon Virtual Private Cloud</a>.</p>"""
    derived_information: NotRequired[
        "capo_sagemaker.types.derived_information.DerivedInformation"
    ]
    """<p>Information that SageMaker Neo automatically derived about the model.</p>"""

compilation_end_time instance-attribute

compilation_end_time: NotRequired[Timestamp]

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 AI detected that the job failed.

compilation_job_arn instance-attribute

compilation_job_arn: NotRequired[CompilationJobArn]

The Amazon Resource Name (ARN) of the model compilation job.

compilation_job_name instance-attribute

compilation_job_name: NotRequired[EntityName]

The name of the model compilation job.

compilation_job_status instance-attribute

compilation_job_status: NotRequired[CompilationJobStatus]

The status of the model compilation job.

compilation_start_time instance-attribute

compilation_start_time: NotRequired[Timestamp]

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. 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.

creation_time instance-attribute

creation_time: NotRequired[CreationTime]

The time that the model compilation job was created.

derived_information instance-attribute

derived_information: NotRequired[DerivedInformation]

Information that SageMaker Neo automatically derived about the model.

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

If a model compilation job failed, the reason it failed.

inference_image instance-attribute

inference_image: NotRequired[InferenceImage]

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

input_config instance-attribute

input_config: NotRequired[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.

last_modified_time instance-attribute

last_modified_time: NotRequired[LastModifiedTime]

The time that the status of the model compilation job was last modified.

model_artifacts instance-attribute

model_artifacts: NotRequired[ModelArtifacts]

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

model_digests instance-attribute

model_digests: NotRequired[ModelDigests]

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

model_package_version_arn instance-attribute

model_package_version_arn: NotRequired[ModelPackageArn]

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

output_config instance-attribute

output_config: NotRequired[OutputConfig]

Information about the output location for the compiled model and the target device that the model runs on.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.

stopping_condition instance-attribute

stopping_condition: NotRequired[StoppingCondition]

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker AI ends the compilation job. Use this API to cap model training costs.

vpc_config instance-attribute

vpc_config: NotRequired[NeoVpcConfig]

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.