aws_sdk_sagemaker/client/
batch_delete_cluster_nodes.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 [`BatchDeleteClusterNodes`](crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_name(impl Into<String>)`](crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name of the SageMaker HyperPod cluster from which to delete the specified nodes.</p><br>
7    ///   - [`node_ids(impl Into<String>)`](crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder::node_ids) / [`set_node_ids(Option<Vec::<String>>)`](crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder::set_node_ids):<br>required: **true**<br><p>A list of node IDs to be deleted from the specified cluster.</p><note>  <ul>   <li>    <p>For SageMaker HyperPod clusters using the Slurm workload manager, you cannot remove instances that are configured as Slurm controller nodes.</p></li>   <li>    <p>If you need to delete more than 99 instances, contact <a href="http://aws.amazon.com/contact-us/">Support</a> for assistance.</p></li>  </ul> </note><br>
8    /// - On success, responds with [`BatchDeleteClusterNodesOutput`](crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput) with field(s):
9    ///   - [`failed(Option<Vec::<BatchDeleteClusterNodesError>>)`](crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput::failed): <p>A list of errors encountered when deleting the specified nodes.</p>
10    ///   - [`successful(Option<Vec::<String>>)`](crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesOutput::successful): <p>A list of node IDs that were successfully deleted from the specified cluster.</p>
11    /// - On failure, responds with [`SdkError<BatchDeleteClusterNodesError>`](crate::operation::batch_delete_cluster_nodes::BatchDeleteClusterNodesError)
12    pub fn batch_delete_cluster_nodes(&self) -> crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder {
13        crate::operation::batch_delete_cluster_nodes::builders::BatchDeleteClusterNodesFluentBuilder::new(self.handle.clone())
14    }
15}