aws_sdk_sagemaker/client/
detach_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 [`DetachClusterNodeVolume`](crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_arn(impl Into<String>)`](crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::cluster_arn) / [`set_cluster_arn(Option<String>)`](crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::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::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::node_id) / [`set_node_id(Option<String>)`](crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::set_node_id):<br>required: **true**<br><p>The unique identifier of the cluster node from which you want to detach the volume.</p><br>
8    ///   - [`volume_id(impl Into<String>)`](crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::volume_id) / [`set_volume_id(Option<String>)`](crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::set_volume_id):<br>required: **true**<br><p>The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node.</p><br>
9    /// - On success, responds with [`DetachClusterNodeVolumeOutput`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput) with field(s):
10    ///   - [`cluster_arn(Option<String>)`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed.</p>
11    ///   - [`node_id(Option<String>)`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput::node_id): <p>The unique identifier of the cluster node from which your volume was detached.</p>
12    ///   - [`volume_id(Option<String>)`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput::volume_id): <p>The unique identifier of your EBS volume that was detached.</p>
13    ///   - [`attach_time(Option<DateTime>)`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput::attach_time): <p>The original timestamp when your volume was initially attached to the node.</p>
14    ///   - [`status(Option<VolumeAttachmentStatus>)`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput::status): <p>The current status of your volume detachment operation.</p>
15    ///   - [`device_name(Option<String>)`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeOutput::device_name): <p>The device name assigned to your attached volume on the target instance.</p>
16    /// - On failure, responds with [`SdkError<DetachClusterNodeVolumeError>`](crate::operation::detach_cluster_node_volume::DetachClusterNodeVolumeError)
17    pub fn detach_cluster_node_volume(&self) -> crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder {
18        crate::operation::detach_cluster_node_volume::builders::DetachClusterNodeVolumeFluentBuilder::new(self.handle.clone())
19    }
20}