Skip to content

Detach Cluster Node Volume

sagemaker_detach_cluster_node_volume R Documentation

Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster

Description

Detaches your Amazon Elastic Block Store (Amazon EBS) volume from a node in your EKS orchestrated SageMaker HyperPod cluster.

This API works with the Amazon Elastic Block Store (Amazon EBS) Container Storage Interface (CSI) driver to manage the lifecycle of persistent storage in your HyperPod EKS clusters.

Usage

sagemaker_detach_cluster_node_volume(ClusterArn, NodeId, VolumeId)

Arguments

ClusterArn

[required] 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 InService state.
NodeId

[required] The unique identifier of the cluster node from which you want to detach the volume.
VolumeId

[required] The unique identifier of your EBS volume that you want to detach. Your volume must be currently attached to the specified node.

Value

A list with the following syntax:

list(
  ClusterArn = "string",
  NodeId = "string",
  VolumeId = "string",
  AttachTime = as.POSIXct(
    "2015-01-01"
  ),
  Status = "attaching"|"attached"|"detaching"|"detached"|"busy",
  DeviceName = "string"
)

Request syntax

svc$detach_cluster_node_volume(
  ClusterArn = "string",
  NodeId = "string",
  VolumeId = "string"
)