aws_sdk_sagemaker/client/

batch_add_cluster_nodes.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`BatchAddClusterNodes`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_name(impl Into<String>)`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name of the HyperPod cluster to which you want to add nodes.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 8 hours. If you retry the request with the same client token within this timeframe and the same parameters, the API returns the same set of <code>NodeLogicalIds</code> with their latest status.</p><br>
    ///   - [`nodes_to_add(AddClusterNodeSpecification)`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::nodes_to_add) / [`set_nodes_to_add(Option<Vec::<AddClusterNodeSpecification>>)`](crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::set_nodes_to_add):<br>required: **true**<br><p>A list of instance groups and the number of nodes to add to each. You can specify up to 5 instance groups in a single request, with a maximum of 50 nodes total across all instance groups.</p><br>
    /// - On success, responds with [`BatchAddClusterNodesOutput`](crate::operation::batch_add_cluster_nodes::BatchAddClusterNodesOutput) with field(s):
    ///   - [`successful(Vec::<NodeAdditionResult>)`](crate::operation::batch_add_cluster_nodes::BatchAddClusterNodesOutput::successful): <p>A list of <code>NodeLogicalIDs</code> that were successfully added to the cluster. The <code>NodeLogicalID</code> is unique per cluster and does not change between instance replacements. Each entry includes a <code>NodeLogicalId</code> that can be used to track the node's provisioning status (with <code>DescribeClusterNode</code>), the instance group name, and the current status of the node.</p>
    ///   - [`failed(Vec::<BatchAddClusterNodesError>)`](crate::operation::batch_add_cluster_nodes::BatchAddClusterNodesOutput::failed): <p>A list of errors that occurred during the node addition operation. Each entry includes the instance group name, error code, number of failed additions, and an error message.</p>
    /// - On failure, responds with [`SdkError<BatchAddClusterNodesError>`](crate::operation::batch_add_cluster_nodes::BatchAddClusterNodesError)
    pub fn batch_add_cluster_nodes(&self) -> crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder {
        crate::operation::batch_add_cluster_nodes::builders::BatchAddClusterNodesFluentBuilder::new(self.handle.clone())
    }
}