SageMaker / Client / attach_cluster_node_volume

attach_cluster_node_volume

SageMaker.Client.attach_cluster_node_volume(**kwargs)

Attaches your Amazon Elastic Block Store (Amazon EBS) volume to a node in your EKS orchestrated 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.attach_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 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).

  • VolumeId (string) –

    [REQUIRED]

    The unique identifier of your EBS volume to attach. The volume must be in the available state.

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 attachment operation was performed.

    • NodeId (string) –

      The unique identifier of the cluster node where your volume was attached.

    • VolumeId (string) –

      The unique identifier of your EBS volume that was attached.

    • AttachTime (datetime) –

      The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.

    • Status (string) –

      The current status of your volume attachment operation.

    • DeviceName (string) –

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

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound