Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusters

Retrieves the list of SageMaker HyperPod clusters.

Request Syntax


{
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NameContains": "string",
   "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.

CreationTimeAfter

Set a start time for the time range during which you want to list SageMaker HyperPod clusters. 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 AWS Command Line Interface User Guide.

Type: Timestamp

Required: No

CreationTimeBefore

Set an end time for the time range during which you want to list SageMaker HyperPod clusters. 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 AWS Command Line Interface User Guide.

Type: Timestamp

Required: No

MaxResults

Set the maximum number of SageMaker HyperPod clusters to list.

Type: Integer

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

Required: No

NameContains

Set the maximum number of instances to print in the list.

Type: String

Length Constraints: Maximum length of 63.

Pattern: [a-zA-Z0-9\-]+

Required: No

NextToken

Set the next token to retrieve the list of SageMaker HyperPod clusters.

Type: String

Length Constraints: 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


{
   "ClusterSummaries": [ 
      { 
         "ClusterArn": "string",
         "ClusterName": "string",
         "ClusterStatus": "string",
         "CreationTime": number
      }
   ],
   "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.

ClusterSummaries

The summaries of listed SageMaker HyperPod clusters.

Type: Array of ClusterSummary objects

NextToken

If the result of the previous ListClusters request was truncated, the response includes a NextToken. To retrieve the next set of clusters, use the token in the next request.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: .*

Errors

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