aws_sdk_sagemaker/operation/batch_delete_cluster_nodes/builders.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::batch_delete_cluster_nodes::_batch_delete_cluster_nodes_output::BatchDeleteClusterNodesOutputBuilder;
pub use crate::operation::batch_delete_cluster_nodes::_batch_delete_cluster_nodes_input::BatchDeleteClusterNodesInputBuilder;
impl crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.batch_delete_cluster_nodes();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `BatchDeleteClusterNodes`.
///
/// <p>Deletes specific nodes within a SageMaker HyperPod cluster. <code>BatchDeleteClusterNodes</code> accepts a cluster name and a list of node IDs.</p><important>
/// <ul>
/// <li>
/// <p>To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate-cli-command.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software-backup">Use the backup script provided by SageMaker HyperPod</a>.</p></li>
/// <li>
/// <p>If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_UpdateClusterSoftware.html">UpdateClusterSoftware API</a>. For more information about patching a cluster, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-hyperpod-operate-cli-command.html#sagemaker-hyperpod-operate-cli-command-update-cluster-software">Update the SageMaker HyperPod platform software of a cluster</a>.</p></li>
/// </ul>
/// </important>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct BatchDeleteClusterNodesFluentBuilder {
handle: ::std::sync::Arc<crate::client::Handle>,
inner: crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesInputBuilder,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput,
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesError,
> for BatchDeleteClusterNodesFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput,
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl BatchDeleteClusterNodesFluentBuilder {
/// Creates a new `BatchDeleteClusterNodesFluentBuilder`.
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 BatchDeleteClusterNodes as a reference.
pub fn as_input(&self) -> &crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesInputBuilder {
&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::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesError,
::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::batch_delete_cluster_nodes::BatchDeleteClusterNodes::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodes::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::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput,
crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesError,
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 name of the SageMaker HyperPod cluster from which to delete the specified nodes.</p>
pub fn cluster_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.cluster_name(input.into());
self
}
/// <p>The name of the SageMaker HyperPod cluster from which to delete the specified nodes.</p>
pub fn set_cluster_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.inner = self.inner.set_cluster_name(input);
self
}
/// <p>The name of the SageMaker HyperPod cluster from which to delete the specified nodes.</p>
pub fn get_cluster_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_cluster_name()
}
///
/// Appends an item to `NodeIds`.
///
/// To override the contents of this collection use [`set_node_ids`](Self::set_node_ids).
///
/// <p>A list of node IDs to be deleted from the specified cluster.</p><note>
/// <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.</p>
/// </note>
pub fn node_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.node_ids(input.into());
self
}
/// <p>A list of node IDs to be deleted from the specified cluster.</p><note>
/// <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.</p>
/// </note>
pub fn set_node_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.inner = self.inner.set_node_ids(input);
self
}
/// <p>A list of node IDs to be deleted from the specified cluster.</p><note>
/// <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.</p>
/// </note>
pub fn get_node_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_node_ids()
}
}