aws_sdk_sagemaker/operation/create_image_version/

builders.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::create_image_version::_create_image_version_output::CreateImageVersionOutputBuilder;

pub use crate::operation::create_image_version::_create_image_version_input::CreateImageVersionInputBuilder;

impl crate::operation::create_image_version::builders::CreateImageVersionInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::create_image_version::CreateImageVersionOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_image_version::CreateImageVersionError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.create_image_version();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `CreateImageVersion`.
///
/// <p>Creates a version of the SageMaker AI image specified by <code>ImageName</code>. The version represents the Amazon ECR container image specified by <code>BaseImage</code>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct CreateImageVersionFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::create_image_version::builders::CreateImageVersionInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl
    crate::client::customize::internal::CustomizableSend<
        crate::operation::create_image_version::CreateImageVersionOutput,
        crate::operation::create_image_version::CreateImageVersionError,
    > for CreateImageVersionFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<
            crate::operation::create_image_version::CreateImageVersionOutput,
            crate::operation::create_image_version::CreateImageVersionError,
        >,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl CreateImageVersionFluentBuilder {
    /// Creates a new `CreateImageVersionFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the CreateImageVersion as a reference.
    pub fn as_input(&self) -> &crate::operation::create_image_version::builders::CreateImageVersionInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::create_image_version::CreateImageVersionOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::create_image_version::CreateImageVersionError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::create_image_version::CreateImageVersion::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::create_image_version::CreateImageVersion::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<
        crate::operation::create_image_version::CreateImageVersionOutput,
        crate::operation::create_image_version::CreateImageVersionError,
        Self,
    > {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <p>The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:</p>
    /// <p><code><acct-id>
    /// .dkr.ecr.
    /// <region>
    /// .amazonaws.com/
    /// <repo-name[:tag] or [@digest]></repo-name[:tag]>
    /// </region>
    /// </acct-id></code></p>
    pub fn base_image(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.base_image(input.into());
        self
    }
    /// <p>The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:</p>
    /// <p><code><acct-id>
    /// .dkr.ecr.
    /// <region>
    /// .amazonaws.com/
    /// <repo-name[:tag] or [@digest]></repo-name[:tag]>
    /// </region>
    /// </acct-id></code></p>
    pub fn set_base_image(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_base_image(input);
        self
    }
    /// <p>The registry path of the container image to use as the starting point for this version. The path is an Amazon ECR URI in the following format:</p>
    /// <p><code><acct-id>
    /// .dkr.ecr.
    /// <region>
    /// .amazonaws.com/
    /// <repo-name[:tag] or [@digest]></repo-name[:tag]>
    /// </region>
    /// </acct-id></code></p>
    pub fn get_base_image(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_base_image()
    }
    /// <p>A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.client_token(input.into());
        self
    }
    /// <p>A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_client_token(input);
        self
    }
    /// <p>A unique ID. If not specified, the Amazon Web Services CLI and Amazon Web Services SDKs, such as the SDK for Python (Boto3), add a unique value to the call.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_client_token()
    }
    /// <p>The <code>ImageName</code> of the <code>Image</code> to create a version of.</p>
    pub fn image_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.image_name(input.into());
        self
    }
    /// <p>The <code>ImageName</code> of the <code>Image</code> to create a version of.</p>
    pub fn set_image_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_image_name(input);
        self
    }
    /// <p>The <code>ImageName</code> of the <code>Image</code> to create a version of.</p>
    pub fn get_image_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_image_name()
    }
    ///
    /// Appends an item to `Aliases`.
    ///
    /// To override the contents of this collection use [`set_aliases`](Self::set_aliases).
    ///
    /// <p>A list of aliases created with the image version.</p>
    pub fn aliases(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.aliases(input.into());
        self
    }
    /// <p>A list of aliases created with the image version.</p>
    pub fn set_aliases(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.inner = self.inner.set_aliases(input);
        self
    }
    /// <p>A list of aliases created with the image version.</p>
    pub fn get_aliases(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        self.inner.get_aliases()
    }
    /// <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>
    pub fn vendor_guidance(mut self, input: crate::types::VendorGuidance) -> Self {
        self.inner = self.inner.vendor_guidance(input);
        self
    }
    /// <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>
    pub fn set_vendor_guidance(mut self, input: ::std::option::Option<crate::types::VendorGuidance>) -> Self {
        self.inner = self.inner.set_vendor_guidance(input);
        self
    }
    /// <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>
    pub fn get_vendor_guidance(&self) -> &::std::option::Option<crate::types::VendorGuidance> {
        self.inner.get_vendor_guidance()
    }
    /// <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>
    pub fn job_type(mut self, input: crate::types::JobType) -> Self {
        self.inner = self.inner.job_type(input);
        self
    }
    /// <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>
    pub fn set_job_type(mut self, input: ::std::option::Option<crate::types::JobType>) -> Self {
        self.inner = self.inner.set_job_type(input);
        self
    }
    /// <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>
    pub fn get_job_type(&self) -> &::std::option::Option<crate::types::JobType> {
        self.inner.get_job_type()
    }
    /// <p>The machine learning framework vended in the image version.</p>
    pub fn ml_framework(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.ml_framework(input.into());
        self
    }
    /// <p>The machine learning framework vended in the image version.</p>
    pub fn set_ml_framework(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_ml_framework(input);
        self
    }
    /// <p>The machine learning framework vended in the image version.</p>
    pub fn get_ml_framework(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_ml_framework()
    }
    /// <p>The supported programming language and its version.</p>
    pub fn programming_lang(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.programming_lang(input.into());
        self
    }
    /// <p>The supported programming language and its version.</p>
    pub fn set_programming_lang(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_programming_lang(input);
        self
    }
    /// <p>The supported programming language and its version.</p>
    pub fn get_programming_lang(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_programming_lang()
    }
    /// <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>
    pub fn processor(mut self, input: crate::types::Processor) -> Self {
        self.inner = self.inner.processor(input);
        self
    }
    /// <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>
    pub fn set_processor(mut self, input: ::std::option::Option<crate::types::Processor>) -> Self {
        self.inner = self.inner.set_processor(input);
        self
    }
    /// <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>
    pub fn get_processor(&self) -> &::std::option::Option<crate::types::Processor> {
        self.inner.get_processor()
    }
    /// <p>Indicates Horovod compatibility.</p>
    pub fn horovod(mut self, input: bool) -> Self {
        self.inner = self.inner.horovod(input);
        self
    }
    /// <p>Indicates Horovod compatibility.</p>
    pub fn set_horovod(mut self, input: ::std::option::Option<bool>) -> Self {
        self.inner = self.inner.set_horovod(input);
        self
    }
    /// <p>Indicates Horovod compatibility.</p>
    pub fn get_horovod(&self) -> &::std::option::Option<bool> {
        self.inner.get_horovod()
    }
    /// <p>The maintainer description of the image version.</p>
    pub fn release_notes(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.release_notes(input.into());
        self
    }
    /// <p>The maintainer description of the image version.</p>
    pub fn set_release_notes(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.inner = self.inner.set_release_notes(input);
        self
    }
    /// <p>The maintainer description of the image version.</p>
    pub fn get_release_notes(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_release_notes()
    }
}