aws_sdk_sagemaker/operation/update_cluster_software/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_cluster_software::_update_cluster_software_output::UpdateClusterSoftwareOutputBuilder;
3
4pub use crate::operation::update_cluster_software::_update_cluster_software_input::UpdateClusterSoftwareInputBuilder;
5
6impl crate::operation::update_cluster_software::builders::UpdateClusterSoftwareInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::update_cluster_software::UpdateClusterSoftwareOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::update_cluster_software::UpdateClusterSoftwareError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.update_cluster_software();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `UpdateClusterSoftware`.
24///
25/// <p>Updates the platform software of a SageMaker HyperPod cluster for security patching. To learn how to use this API, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software">Update the SageMaker HyperPod platform software of a cluster</a>.</p><important>
26/// <p>The <code>UpgradeClusterSoftware</code> API call may impact your SageMaker HyperPod cluster uptime and availability. Plan accordingly to mitigate potential disruptions to your workloads.</p>
27/// </important>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct UpdateClusterSoftwareFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::update_cluster_software::builders::UpdateClusterSoftwareInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::update_cluster_software::UpdateClusterSoftwareOutput,
37        crate::operation::update_cluster_software::UpdateClusterSoftwareError,
38    > for UpdateClusterSoftwareFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::update_cluster_software::UpdateClusterSoftwareOutput,
46            crate::operation::update_cluster_software::UpdateClusterSoftwareError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl UpdateClusterSoftwareFluentBuilder {
53    /// Creates a new `UpdateClusterSoftwareFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the UpdateClusterSoftware as a reference.
62    pub fn as_input(&self) -> &crate::operation::update_cluster_software::builders::UpdateClusterSoftwareInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::update_cluster_software::UpdateClusterSoftwareOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::update_cluster_software::UpdateClusterSoftwareError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::update_cluster_software::UpdateClusterSoftware::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::update_cluster_software::UpdateClusterSoftware::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::update_cluster_software::UpdateClusterSoftwareOutput,
99        crate::operation::update_cluster_software::UpdateClusterSoftwareError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// <p>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.</p>
114    pub fn cluster_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
115        self.inner = self.inner.cluster_name(input.into());
116        self
117    }
118    /// <p>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.</p>
119    pub fn set_cluster_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
120        self.inner = self.inner.set_cluster_name(input);
121        self
122    }
123    /// <p>Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.</p>
124    pub fn get_cluster_name(&self) -> &::std::option::Option<::std::string::String> {
125        self.inner.get_cluster_name()
126    }
127    ///
128    /// Appends an item to `InstanceGroups`.
129    ///
130    /// To override the contents of this collection use [`set_instance_groups`](Self::set_instance_groups).
131    ///
132    /// <p>The array of instance groups for which to update AMI versions.</p>
133    pub fn instance_groups(mut self, input: crate::types::UpdateClusterSoftwareInstanceGroupSpecification) -> Self {
134        self.inner = self.inner.instance_groups(input);
135        self
136    }
137    /// <p>The array of instance groups for which to update AMI versions.</p>
138    pub fn set_instance_groups(
139        mut self,
140        input: ::std::option::Option<::std::vec::Vec<crate::types::UpdateClusterSoftwareInstanceGroupSpecification>>,
141    ) -> Self {
142        self.inner = self.inner.set_instance_groups(input);
143        self
144    }
145    /// <p>The array of instance groups for which to update AMI versions.</p>
146    pub fn get_instance_groups(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::UpdateClusterSoftwareInstanceGroupSpecification>> {
147        self.inner.get_instance_groups()
148    }
149    /// <p>The configuration to use when updating the AMI versions.</p>
150    pub fn deployment_config(mut self, input: crate::types::DeploymentConfiguration) -> Self {
151        self.inner = self.inner.deployment_config(input);
152        self
153    }
154    /// <p>The configuration to use when updating the AMI versions.</p>
155    pub fn set_deployment_config(mut self, input: ::std::option::Option<crate::types::DeploymentConfiguration>) -> Self {
156        self.inner = self.inner.set_deployment_config(input);
157        self
158    }
159    /// <p>The configuration to use when updating the AMI versions.</p>
160    pub fn get_deployment_config(&self) -> &::std::option::Option<crate::types::DeploymentConfiguration> {
161        self.inner.get_deployment_config()
162    }
163}
aws_sdk_sagemaker/operation/update_cluster_software/builders.rs

aws_sdk_sagemaker/operation/update_cluster_software/
builders.rs
