aws_sdk_sagemaker/client/

describe_image_version.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeImageVersion`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`image_name(impl Into<String>)`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::image_name) / [`set_image_name(Option<String>)`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::set_image_name):<br>required: **true**<br><p>The name of the image.</p><br>
    ///   - [`version(i32)`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::version) / [`set_version(Option<i32>)`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::set_version):<br>required: **false**<br><p>The version of the image. If not specified, the latest version is described.</p><br>
    ///   - [`alias(impl Into<String>)`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::alias) / [`set_alias(Option<String>)`](crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::set_alias):<br>required: **false**<br><p>The alias of the image version.</p><br>
    /// - On success, responds with [`DescribeImageVersionOutput`](crate::operation::describe_image_version::DescribeImageVersionOutput) with field(s):
    ///   - [`base_image(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::base_image): <p>The registry path of the container image on which this image version is based.</p>
    ///   - [`container_image(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::container_image): <p>The registry path of the container image that contains this image version.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::creation_time): <p>When the version was created.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::failure_reason): <p>When a create or delete operation fails, the reason for the failure.</p>
    ///   - [`image_arn(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::image_arn): <p>The ARN of the image the version is based on.</p>
    ///   - [`image_version_arn(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::image_version_arn): <p>The ARN of the version.</p>
    ///   - [`image_version_status(Option<ImageVersionStatus>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::image_version_status): <p>The status of the version.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::last_modified_time): <p>When the version was last modified.</p>
    ///   - [`version(Option<i32>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::version): <p>The version number.</p>
    ///   - [`vendor_guidance(Option<VendorGuidance>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::vendor_guidance): <p>The stability of the image version specified by the maintainer.</p> <ul>  <li>   <p><code>NOT_PROVIDED</code>: The maintainers did not provide a status for image version stability.</p></li>  <li>   <p><code>STABLE</code>: The image version is stable.</p></li>  <li>   <p><code>TO_BE_ARCHIVED</code>: The image version is set to be archived. Custom image versions that are set to be archived are automatically archived after three months.</p></li>  <li>   <p><code>ARCHIVED</code>: The image version is archived. Archived image versions are not searchable and are no longer actively supported.</p></li> </ul>
    ///   - [`job_type(Option<JobType>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::job_type): <p>Indicates SageMaker AI job type compatibility.</p> <ul>  <li>   <p><code>TRAINING</code>: The image version is compatible with SageMaker AI training jobs.</p></li>  <li>   <p><code>INFERENCE</code>: The image version is compatible with SageMaker AI inference jobs.</p></li>  <li>   <p><code>NOTEBOOK_KERNEL</code>: The image version is compatible with SageMaker AI notebook kernels.</p></li> </ul>
    ///   - [`ml_framework(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::ml_framework): <p>The machine learning framework vended in the image version.</p>
    ///   - [`programming_lang(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::programming_lang): <p>The supported programming language and its version.</p>
    ///   - [`processor(Option<Processor>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::processor): <p>Indicates CPU or GPU compatibility.</p> <ul>  <li>   <p><code>CPU</code>: The image version is compatible with CPU.</p></li>  <li>   <p><code>GPU</code>: The image version is compatible with GPU.</p></li> </ul>
    ///   - [`horovod(Option<bool>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::horovod): <p>Indicates Horovod compatibility.</p>
    ///   - [`release_notes(Option<String>)`](crate::operation::describe_image_version::DescribeImageVersionOutput::release_notes): <p>The maintainer description of the image version.</p>
    /// - On failure, responds with [`SdkError<DescribeImageVersionError>`](crate::operation::describe_image_version::DescribeImageVersionError)
    pub fn describe_image_version(&self) -> crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder {
        crate::operation::describe_image_version::builders::DescribeImageVersionFluentBuilder::new(self.handle.clone())
    }
}