AttachClusterNodeVolume
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.
Request Syntax
{
"ClusterArn": "string",
"NodeId": "string",
"VolumeId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClusterArn
-
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
InServicestate.Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12}Required: Yes
- NodeId
-
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: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
i-[a-f0-9]{8}(?:[a-f0-9]{9})?Required: Yes
- VolumeId
-
The unique identifier of your EBS volume to attach. The volume must be in the
availablestate.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
vol-[a-f0-9]{8}(?:[a-f0-9]{9})?Required: Yes
Response Syntax
{
"AttachTime": number,
"ClusterArn": "string",
"DeviceName": "string",
"NodeId": "string",
"Status": "string",
"VolumeId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AttachTime
-
The timestamp when the volume attachment operation was initiated by the SageMaker HyperPod service.
Type: Timestamp
- ClusterArn
-
The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the volume attachment operation was performed.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Pattern:
arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:cluster/[a-z0-9]{12} - DeviceName
-
The device name assigned to your attached volume on the target instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 32.
Pattern:
/dev/(xvd[a-z]|sd[b-z]|sd[f-p][1-6]) - NodeId
-
The unique identifier of the cluster node where your volume was attached.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
i-[a-f0-9]{8}(?:[a-f0-9]{9})? - Status
-
The current status of your volume attachment operation.
Type: String
Valid Values:
attaching | attached | detaching | detached | busy - VolumeId
-
The unique identifier of your EBS volume that was attached.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
vol-[a-f0-9]{8}(?:[a-f0-9]{9})?
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFound
-
Resource being access is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
