Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusterOperations

Retrieves a list of operation summaries for a specified HyperPod cluster, such as scaling operations and deep health checks. The operation supports filtering, sorting, and pagination of results.

Request Syntax


{
   "ClusterName": "string",
   "CreationTimeAfter": number,
   "CreationTimeBefore": number,
   "MaxResults": number,
   "NextToken": "string",
   "SortBy": "string",
   "SortOrder": "string",
   "Status": "string",
   "Type": "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 name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list operations.

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

CreationTimeAfter

The start of the time range for filtering operations. Only operations created after this time are included in the results.

Type: Timestamp

Required: No

CreationTimeBefore

The end of the time range for filtering operations. Only operations created before this time are included in the results.

Type: Timestamp

Required: No

MaxResults

The maximum number of operations to return in the response. Valid range is 1 to 100.

Type: Integer

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

Required: No

NextToken

A token to retrieve the next set of results. This token is obtained from the output of a previous ListClusterOperations call.

Type: String

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

Pattern: .*

Required: No

SortBy

The field to use for sorting the operation list. Currently, the only supported value is CreationTime.

Type: String

Valid Values: CreationTime

Required: No

SortOrder

The order in which to sort the results. Valid values are Ascending or Descending (the default is Descending).

Type: String

Valid Values: Ascending | Descending

Required: No

Status

The operation status to filter by. If specified, only operations with this status are returned. Valid values are InProgress, Superseded, or Done.

Type: String

Valid Values: InProgress | Superseded | Done

Required: No

Type

The operation type to filter by. If specified, only operations of this type are returned. Valid values are Scaling or DeepHealthCheck.

Type: String

Valid Values: Scaling | DeepHealthCheck

Required: No

Response Syntax


{
   "ClusterOperationSummaries": [ 
      { 
         "ClusterArn": "string",
         "CreationTime": number,
         "OperationId": "string",
         "Status": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}