SageMaker / Client / list_cluster_nodes

list_cluster_nodes

SageMaker.Client.list_cluster_nodes(**kwargs)

Retrieves the list of instances (also called nodes interchangeably) in a SageMaker HyperPod cluster.

See also: AWS API Documentation

Request Syntax

response = client.list_cluster_nodes(
    ClusterName='string',
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    InstanceGroupNameContains='string',
    MaxResults=123,
    NextToken='string',
    SortBy='CREATION_TIME'|'NAME',
    SortOrder='Ascending'|'Descending'
)

Parameters:

• ClusterName (string) –

  [REQUIRED]

  The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

• CreationTimeAfter (datetime) –

  A filter that returns nodes in a SageMaker HyperPod cluster created after the specified time. Timestamps are formatted according to the ISO 8601 standard.

  Acceptable formats include:

  • YYYY-MM-DDThh:mm:ss.sssTZD (UTC), for example, 2014-10-01T20:30:00.000Z

  • YYYY-MM-DDThh:mm:ss.sssTZD (with offset), for example, 2014-10-01T12:30:00.000-08:00

  • YYYY-MM-DD, for example, 2014-10-01

  • Unix time in seconds, for example, 1412195400. This is also referred to as Unix Epoch time and represents the number of seconds since midnight, January 1, 1970 UTC.

  For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

• CreationTimeBefore (datetime) – A filter that returns nodes in a SageMaker HyperPod cluster created before the specified time. The acceptable formats are the same as the timestamp formats for CreationTimeAfter. For more information about the timestamp format, see Timestamp in the Amazon Web Services Command Line Interface User Guide.

• InstanceGroupNameContains (string) – A filter that returns the instance groups whose name contain a specified string.

• MaxResults (integer) – The maximum number of nodes to return in the response.

• NextToken (string) – If the result of the previous ListClusterNodes request was truncated, the response includes a NextToken. To retrieve the next set of cluster nodes, use the token in the next request.

• SortBy (string) – The field by which to sort results. The default value is CREATION_TIME.

• SortOrder (string) – The sort order for results. The default value is Ascending.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'ClusterNodeSummaries': [
        {
            'InstanceGroupName': 'string',
            'InstanceId': '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),
            'InstanceStatus': {
                'Status': 'Running'|'Failure'|'Pending'|'ShuttingDown'|'SystemUpdating'|'DeepHealthCheckInProgress',
                'Message': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    The next token specified for listing instances in a SageMaker HyperPod cluster.

  • ClusterNodeSummaries (list) –

    The summaries of listed instances in a SageMaker HyperPod cluster

    • (dict) –

      Lists a summary of the properties of an instance (also called a node interchangeably) of a SageMaker HyperPod cluster.

      • InstanceGroupName (string) –

        The name of the instance group in which the instance is.

      • InstanceId (string) –

        The ID of the instance.

      • InstanceType (string) –

        The type of the instance.

      • LaunchTime (datetime) –

        The time when the instance is launched.

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

Exceptions

• SageMaker.Client.exceptions.ResourceNotFound