aws_sdk_sagemaker/client/

describe_compilation_job.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeCompilationJob`](crate::operation::describe_compilation_job::builders::DescribeCompilationJobFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`compilation_job_name(impl Into<String>)`](crate::operation::describe_compilation_job::builders::DescribeCompilationJobFluentBuilder::compilation_job_name) / [`set_compilation_job_name(Option<String>)`](crate::operation::describe_compilation_job::builders::DescribeCompilationJobFluentBuilder::set_compilation_job_name):<br>required: **true**<br><p>The name of the model compilation job that you want information about.</p><br>
    /// - On success, responds with [`DescribeCompilationJobOutput`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput) with field(s):
    ///   - [`compilation_job_name(Option<String>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::compilation_job_name): <p>The name of the model compilation job.</p>
    ///   - [`compilation_job_arn(Option<String>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::compilation_job_arn): <p>The Amazon Resource Name (ARN) of the model compilation job.</p>
    ///   - [`compilation_job_status(Option<CompilationJobStatus>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::compilation_job_status): <p>The status of the model compilation job.</p>
    ///   - [`compilation_start_time(Option<DateTime>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::compilation_start_time): <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(Option<DateTime>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::compilation_end_time): <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(Option<StoppingCondition>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::stopping_condition): <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(Option<String>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::inference_image): <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(Option<String>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::model_package_version_arn): <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(Option<DateTime>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::creation_time): <p>The time that the model compilation job was created.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::last_modified_time): <p>The time that the status of the model compilation job was last modified.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::failure_reason): <p>If a model compilation job failed, the reason it failed.</p>
    ///   - [`model_artifacts(Option<ModelArtifacts>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::model_artifacts): <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(Option<ModelDigests>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::model_digests): <p>Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.</p>
    ///   - [`role_arn(Option<String>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::role_arn): <p>The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker AI assumes to perform the model compilation job.</p>
    ///   - [`input_config(Option<InputConfig>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::input_config): <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(Option<OutputConfig>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::output_config): <p>Information about the output location for the compiled model and the target device that the model runs on.</p>
    ///   - [`vpc_config(Option<NeoVpcConfig>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::vpc_config): <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(Option<DerivedInformation>)`](crate::operation::describe_compilation_job::DescribeCompilationJobOutput::derived_information): <p>Information that SageMaker Neo automatically derived about the model.</p>
    /// - On failure, responds with [`SdkError<DescribeCompilationJobError>`](crate::operation::describe_compilation_job::DescribeCompilationJobError)
    pub fn describe_compilation_job(&self) -> crate::operation::describe_compilation_job::builders::DescribeCompilationJobFluentBuilder {
        crate::operation::describe_compilation_job::builders::DescribeCompilationJobFluentBuilder::new(self.handle.clone())
    }
}