SageMaker / Client / detach_cluster_node_volume

detach_cluster_node_volume

SageMaker.Client.detach_cluster_node_volume(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.detach_cluster_node_volume(
    ClusterArn='string',
    NodeId='string',
    VolumeId='string'
)

Parameters:

• ClusterArn (string) –

  [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 (string) –

  [REQUIRED]

  The unique identifier of the cluster node from which you want to detach the volume.

• VolumeId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'NodeId': 'string',
    'VolumeId': 'string',
    'AttachTime': datetime(2015, 1, 1),
    'Status': 'attaching'|'attached'|'detaching'|'detached'|'busy',
    'DeviceName': 'string'
}

Response Structure

• (dict) –

  • ClusterArn (string) –

    The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume detachment operation was performed.

  • NodeId (string) –

    The unique identifier of the cluster node from which your volume was detached.

  • VolumeId (string) –

    The unique identifier of your EBS volume that was detached.

  • AttachTime (datetime) –

    The original timestamp when your volume was initially attached to the node.

  • Status (string) –

    The current status of your volume detachment operation.

  • DeviceName (string) –

    The device name assigned to your attached volume on the target instance.

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound