aws_sdk_sagemaker/client/
attach_cluster_node_volume.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 [`AttachClusterNodeVolume`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_arn(impl Into<String>)`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::cluster_arn) / [`set_cluster_arn(Option<String>)`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::set_cluster_arn):<br>required: **true**<br><p>The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster containing the target node. Your cluster must use EKS as the orchestration and be in the <code>InService</code> state.</p><br>
7    ///   - [`node_id(impl Into<String>)`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::node_id) / [`set_node_id(Option<String>)`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::set_node_id):<br>required: **true**<br><p>The unique identifier of the cluster node to which you want to attach the volume. The node must belong to your specified HyperPod cluster and cannot be part of a Restricted Instance Group (RIG).</p><br>
8    ///   - [`volume_id(impl Into<String>)`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::volume_id) / [`set_volume_id(Option<String>)`](crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::set_volume_id):<br>required: **true**<br><p>The unique identifier of your EBS volume to attach. The volume must be in the <code>available</code> state.</p><br>
9    /// - On success, responds with [`AttachClusterNodeVolumeOutput`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput) with field(s):
10    ///   - [`cluster_arn(Option<String>)`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed.</p>
11    ///   - [`node_id(Option<String>)`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput::node_id): <p>The unique identifier of the cluster node where your volume was attached.</p>
12    ///   - [`volume_id(Option<String>)`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput::volume_id): <p>The unique identifier of your EBS volume that was attached.</p>
13    ///   - [`attach_time(Option<DateTime>)`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput::attach_time): <p>The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.</p>
14    ///   - [`status(Option<VolumeAttachmentStatus>)`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput::status): <p>The current status of your volume attachment operation.</p>
15    ///   - [`device_name(Option<String>)`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeOutput::device_name): <p>The device name assigned to your attached volume on the target instance.</p>
16    /// - On failure, responds with [`SdkError<AttachClusterNodeVolumeError>`](crate::operation::attach_cluster_node_volume::AttachClusterNodeVolumeError)
17    pub fn attach_cluster_node_volume(&self) -> crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder {
18        crate::operation::attach_cluster_node_volume::builders::AttachClusterNodeVolumeFluentBuilder::new(self.handle.clone())
19    }
20}