SageMaker / Client / describe_cluster_node

describe_cluster_node#

SageMaker.Client.describe_cluster_node(**kwargs)#

Retrieves information of a node (also called a instance interchangeably) of a SageMaker HyperPod cluster.

Request Syntax

response = client.describe_cluster_node(
    ClusterName='string',
    NodeId='string'
)

Parameters:

ClusterName (string) –
[REQUIRED]

The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which the node is.
NodeId (string) –
[REQUIRED]

The ID of the SageMaker HyperPod cluster node.

Return type:

dict

Returns:

Response Syntax

{
    'NodeDetails': {
        'InstanceGroupName': 'string',
        'InstanceId': 'string',
        'InstanceStatus': {
            'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating'|'DeepHealthCheckInProgress',
            'Message': 'string'
        },
        'InstanceType': 'ml.p4d.24xlarge'|'ml.p4de.24xlarge'|'ml.p5.48xlarge'|'ml.trn1.32xlarge'|'ml.trn1n.32xlarge'|'ml.g5.xlarge'|'ml.g5.2xlarge'|'ml.g5.4xlarge'|'ml.g5.8xlarge'|'ml.g5.12xlarge'|'ml.g5.16xlarge'|'ml.g5.24xlarge'|'ml.g5.48xlarge'|'ml.c5.large'|'ml.c5.xlarge'|'ml.c5.2xlarge'|'ml.c5.4xlarge'|'ml.c5.9xlarge'|'ml.c5.12xlarge'|'ml.c5.18xlarge'|'ml.c5.24xlarge'|'ml.c5n.large'|'ml.c5n.2xlarge'|'ml.c5n.4xlarge'|'ml.c5n.9xlarge'|'ml.c5n.18xlarge'|'ml.m5.large'|'ml.m5.xlarge'|'ml.m5.2xlarge'|'ml.m5.4xlarge'|'ml.m5.8xlarge'|'ml.m5.12xlarge'|'ml.m5.16xlarge'|'ml.m5.24xlarge'|'ml.t3.medium'|'ml.t3.large'|'ml.t3.xlarge'|'ml.t3.2xlarge'|'ml.g6.xlarge'|'ml.g6.2xlarge'|'ml.g6.4xlarge'|'ml.g6.8xlarge'|'ml.g6.16xlarge'|'ml.g6.12xlarge'|'ml.g6.24xlarge'|'ml.g6.48xlarge'|'ml.gr6.4xlarge'|'ml.gr6.8xlarge'|'ml.g6e.xlarge'|'ml.g6e.2xlarge'|'ml.g6e.4xlarge'|'ml.g6e.8xlarge'|'ml.g6e.16xlarge'|'ml.g6e.12xlarge'|'ml.g6e.24xlarge'|'ml.g6e.48xlarge'|'ml.p5e.48xlarge'|'ml.p5en.48xlarge'|'ml.trn2.48xlarge'|'ml.c6i.large'|'ml.c6i.xlarge'|'ml.c6i.2xlarge'|'ml.c6i.4xlarge'|'ml.c6i.8xlarge'|'ml.c6i.12xlarge'|'ml.c6i.16xlarge'|'ml.c6i.24xlarge'|'ml.c6i.32xlarge'|'ml.m6i.large'|'ml.m6i.xlarge'|'ml.m6i.2xlarge'|'ml.m6i.4xlarge'|'ml.m6i.8xlarge'|'ml.m6i.12xlarge'|'ml.m6i.16xlarge'|'ml.m6i.24xlarge'|'ml.m6i.32xlarge'|'ml.r6i.large'|'ml.r6i.xlarge'|'ml.r6i.2xlarge'|'ml.r6i.4xlarge'|'ml.r6i.8xlarge'|'ml.r6i.12xlarge'|'ml.r6i.16xlarge'|'ml.r6i.24xlarge'|'ml.r6i.32xlarge',
        'LaunchTime': datetime(2015, 1, 1),
        'LifeCycleConfig': {
            'SourceS3Uri': 'string',
            'OnCreate': 'string'
        },
        'OverrideVpcConfig': {
            'SecurityGroupIds': [
                'string',
            ],
            'Subnets': [
                'string',
            ]
        },
        'ThreadsPerCore': 123,
        'InstanceStorageConfigs': [
            {
                'EbsVolumeConfig': {
                    'VolumeSizeInGB': 123
                }
            },
        ],
        'PrivatePrimaryIp': 'string',
        'PrivateDnsHostname': 'string',
        'Placement': {
            'AvailabilityZone': 'string',
            'AvailabilityZoneId': 'string'
        }
    }
}

Response Structure

(dict) –
- NodeDetails (dict) –
  
  The details of the SageMaker HyperPod cluster node.
  - InstanceGroupName (string) –
    
    The instance group name in which the instance is.
  - InstanceId (string) –
    
    The ID of the instance.
  - InstanceStatus (dict) –
    
    The status of the instance.
    - Status (string) –
      
      The status of an instance in a SageMaker HyperPod cluster.
    - Message (string) –
      
      The message from an instance in a SageMaker HyperPod cluster.
  - InstanceType (string) –
    
    The type of the instance.
  - LaunchTime (datetime) –
    
    The time when the instance is launched.
  - LifeCycleConfig (dict) –
    
    The LifeCycle configuration applied to the instance.
    - SourceS3Uri (string) –
      
      An Amazon S3 bucket path where your lifecycle scripts are stored.
      
      Warning
      Make sure that the S3 bucket path starts with s3://sagemaker-. The IAM role for SageMaker HyperPod has the managed AmazonSageMakerClusterInstanceRolePolicy attached, which allows access to S3 buckets with the specific prefix sagemaker-.
    - OnCreate (string) –
      
      The file name of the entrypoint script of lifecycle scripts under SourceS3Uri. This entrypoint script runs during cluster creation.
  - OverrideVpcConfig (dict) –
    
    Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see Give SageMaker Access to Resources in your Amazon VPC.
    - SecurityGroupIds (list) –
      
      The VPC security group IDs, in the form sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field.
      - (string) –
    - Subnets (list) –
      
      The ID of the subnets in the VPC to which you want to connect your training job or model. For information about the availability of specific instance types, see Supported Instance Types and Availability Zones.
      - (string) –
  - ThreadsPerCore (integer) –
    
    The number of threads per CPU core you specified under CreateCluster.
  - InstanceStorageConfigs (list) –
    
    The configurations of additional storage specified to the instance group where the instance (node) is launched.
    - (dict) –
      
      Defines the configuration for attaching additional storage to the instances in the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: EbsVolumeConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - EbsVolumeConfig (dict) –
        
        Defines the configuration for attaching additional Amazon Elastic Block Store (EBS) volumes to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
        
        VolumeSizeInGB (integer) –
        
        The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker.
  - PrivatePrimaryIp (string) –
    
    The private primary IP address of the SageMaker HyperPod cluster node.
  - PrivateDnsHostname (string) –
    
    The private DNS hostname of the SageMaker HyperPod cluster node.
  - Placement (dict) –
    
    The placement details of the SageMaker HyperPod cluster node.
    - AvailabilityZone (string) –
      
      The Availability Zone where the node in the SageMaker HyperPod cluster is launched.
    - AvailabilityZoneId (string) –
      
      The unique identifier (ID) of the Availability Zone where the node in the SageMaker HyperPod cluster is launched.

Exceptions

SageMaker.Client.exceptions.ResourceNotFound