Amazon SageMaker Service

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

client.attach_cluster_node_volume(
    ClusterArn='string',
    NodeId='string',
    VolumeId='string'
)

type ClusterArn:

string

param 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.

type NodeId:

string

param NodeId:

[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).

type VolumeId:

string

param VolumeId:

[REQUIRED]

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

rtype:

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.

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

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

type ClusterArn:

string

param 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.

type NodeId:

string

param NodeId:

[REQUIRED]

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

type VolumeId:

string

param VolumeId:

[REQUIRED]

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

rtype:

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.