Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

AttachClusterNodeNetworkInterface

Attaches an elastic network interface (ENI) to a node in a HyperPod cluster.

To use this operation, you must have the sagemaker:AttachClusterNodeNetworkInterface permission.

Request Syntax


{
   "ClusterName": "string",
   "NetworkInterfaceId": "string",
   "NodeId": "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.

ClusterName

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster that contains the target node.

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})|([a-zA-Z0-9](-*[a-zA-Z0-9]){0,62})

Required: Yes

NetworkInterfaceId

The unique identifier of the elastic network interface (ENI) to attach.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 21.

Pattern: eni-[0-9a-f]{8}(?:[0-9a-f]{9})?

Required: Yes

NodeId

The unique identifier of the cluster node to which you want to attach the network interface. 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

Response Syntax


{
   "AttachmentId": "string",
   "ClusterArn": "string",
   "NetworkInterfaceId": "string",
   "NodeId": "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.

AttachmentId

The unique identifier of the network interface attachment. Use this value to reference or detach the network interface later.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 28.

Pattern: eni-attach-[0-9a-f]{8}(?:[0-9a-f]{9})?

ClusterArn

The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the network interface 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}

NetworkInterfaceId

The unique identifier of the elastic network interface (ENI) that was attached.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 21.

Pattern: eni-[0-9a-f]{8}(?:[0-9a-f]{9})?

NodeId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: i-[a-f0-9]{8}(?:[a-f0-9]{9})?

Errors

For information about the errors that are common to all actions, see Common Error Types.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400