aws_sdk_sagemaker/client/
update_image_version.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateImageVersion`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`image_name(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::image_name) / [`set_image_name(Option<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_image_name):<br>required: **true**<br><p>The name of the image.</p><br>
7    ///   - [`alias(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::alias) / [`set_alias(Option<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_alias):<br>required: **false**<br><p>The alias of the image version.</p><br>
8    ///   - [`version(i32)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::version) / [`set_version(Option<i32>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_version):<br>required: **false**<br><p>The version of the image.</p><br>
9    ///   - [`aliases_to_add(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::aliases_to_add) / [`set_aliases_to_add(Option<Vec::<String>>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_aliases_to_add):<br>required: **false**<br><p>A list of aliases to add.</p><br>
10    ///   - [`aliases_to_delete(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::aliases_to_delete) / [`set_aliases_to_delete(Option<Vec::<String>>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_aliases_to_delete):<br>required: **false**<br><p>A list of aliases to delete.</p><br>
11    ///   - [`vendor_guidance(VendorGuidance)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::vendor_guidance) / [`set_vendor_guidance(Option<VendorGuidance>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_vendor_guidance):<br>required: **false**<br><p>The availability 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><br>
12    ///   - [`job_type(JobType)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::job_type) / [`set_job_type(Option<JobType>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_job_type):<br>required: **false**<br><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><br>
13    ///   - [`ml_framework(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::ml_framework) / [`set_ml_framework(Option<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_ml_framework):<br>required: **false**<br><p>The machine learning framework vended in the image version.</p><br>
14    ///   - [`programming_lang(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::programming_lang) / [`set_programming_lang(Option<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_programming_lang):<br>required: **false**<br><p>The supported programming language and its version.</p><br>
15    ///   - [`processor(Processor)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::processor) / [`set_processor(Option<Processor>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_processor):<br>required: **false**<br><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><br>
16    ///   - [`horovod(bool)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::horovod) / [`set_horovod(Option<bool>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_horovod):<br>required: **false**<br><p>Indicates Horovod compatibility.</p><br>
17    ///   - [`release_notes(impl Into<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::release_notes) / [`set_release_notes(Option<String>)`](crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::set_release_notes):<br>required: **false**<br><p>The maintainer description of the image version.</p><br>
18    /// - On success, responds with [`UpdateImageVersionOutput`](crate::operation::update_image_version::UpdateImageVersionOutput) with field(s):
19    ///   - [`image_version_arn(Option<String>)`](crate::operation::update_image_version::UpdateImageVersionOutput::image_version_arn): <p>The ARN of the image version.</p>
20    /// - On failure, responds with [`SdkError<UpdateImageVersionError>`](crate::operation::update_image_version::UpdateImageVersionError)
21    pub fn update_image_version(&self) -> crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder {
22        crate::operation::update_image_version::builders::UpdateImageVersionFluentBuilder::new(self.handle.clone())
23    }
24}