SageMaker / Client / describe_cluster_node

describe_cluster_node#

SageMaker.Client.describe_cluster_node(**kwargs)#

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

See also: AWS API Documentation

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 instance is.

  • NodeId (string) –

    [REQUIRED]

    The ID of the instance.

Return type:

dict

Returns:

Response Syntax

{
    'NodeDetails': {
        'InstanceGroupName': 'string',
        'InstanceId': 'string',
        'InstanceStatus': {
            'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating',
            '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',
        'LaunchTime': datetime(2015, 1, 1),
        'LifeCycleConfig': {
            'SourceS3Uri': 'string',
            'OnCreate': 'string'
        },
        'ThreadsPerCore': 123
    }
}

Response Structure

  • (dict) –

    • NodeDetails (dict) –

      The details of the instance.

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

        • OnCreate (string) –

          The directory of the LifeCycle script under SourceS3Uri. This LifeCycle script runs during cluster creation.

      • ThreadsPerCore (integer) –

        The number of threads per CPU core you specified under CreateCluster.

Exceptions

  • SageMaker.Client.exceptions.ResourceNotFound