Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusterNodes

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

Request Syntax


{
   "ClusterName": "string",
   "IncludeNodeLogicalIds": boolean,
   "InstanceGroupNameContains": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "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 string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster in which you want to retrieve the list of nodes.

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

IncludeNodeLogicalIds

Specifies whether to include nodes that are still being provisioned in the response. When set to true, the response includes all nodes regardless of their provisioning status. When set to False (default), only nodes with assigned InstanceIds are returned.

Type: Boolean

Required: No

InstanceGroupNameContains

A filter that returns the instance groups whose name contain a specified string.

Type: String

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

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

MaxResults

The maximum number of nodes to return in the response.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Required: No

SortBy

The field by which to sort results. The default value is CREATION_TIME.

Type: String

Valid Values: CREATION_TIME | NAME

Required: No

SortOrder

The sort order for results. The default value is Ascending.

Type: String

Valid Values: Ascending | Descending

Required: No

Response Syntax


{
   "ClusterNodeSummaries": [ 
      { 
         "CurrentImageReleaseVersion": "string",
         "ImageVersionStatus": "string",
         "InstanceGroupName": "string",
         "InstanceId": "string",
         "InstanceStatus": { 
            "Message": "string",
            "Status": "string"
         },
         "InstanceType": "string",
         "NodeLogicalId": "string",
         "PrivateDnsHostname": "string",
         "UltraServerInfo": { 
            "Id": "string",
            "Type": "string"
         }
      }
   ],
   "NextToken": "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.

ClusterNodeSummaries

The summaries of listed instances in a SageMaker HyperPod cluster

Type: Array of ClusterNodeSummary objects

NextToken

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 8192.

Pattern: .*

Errors

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400