SageMaker / Client / attach_cluster_node_network_interface

attach_cluster_node_network_interface

SageMaker.Client.attach_cluster_node_network_interface(**kwargs)

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

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

See also: AWS API Documentation

Request Syntax

response = client.attach_cluster_node_network_interface(
    ClusterName='string',
    NodeId='string',
    NetworkInterfaceId='string'
)

Parameters:

• ClusterName (string) –

  [REQUIRED]

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

• NodeId (string) –

  [REQUIRED]

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

• NetworkInterfaceId (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ClusterArn': 'string',
    'NodeId': 'string',
    'NetworkInterfaceId': 'string',
    'AttachmentId': 'string'
}

Response Structure

• (dict) –

  • ClusterArn (string) –

    The Amazon Resource Name (ARN) of your SageMaker HyperPod cluster where the network interface attachment operation was performed.

  • NodeId (string) –

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

  • NetworkInterfaceId (string) –

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

  • AttachmentId (string) –

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

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound

• SageMaker.Client.exceptions.ResourceLimitExceeded