Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListClusterEvents

Retrieves a list of event summaries for a specified HyperPod cluster. The operation supports filtering, sorting, and pagination of results. This functionality is only supported when the NodeProvisioningMode is set to Continuous.

Request Syntax


{
   "ClusterName": "string",
   "EventTimeAfter": number,
   "EventTimeBefore": number,
   "InstanceGroupName": "string",
   "MaxResults": number,
   "NextToken": "string",
   "NodeId": "string",
   "ResourceType": "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 name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

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

EventTimeAfter

The start of the time range for filtering events. Only events that occurred after this time are included in the results.

Type: Timestamp

Required: No

EventTimeBefore

The end of the time range for filtering events. Only events that occurred before this time are included in the results.

Type: Timestamp

Required: No

InstanceGroupName

The name of the instance group to filter events. If specified, only events related to this instance group are returned.

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 events 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 ListClusterEvents call.

Type: String

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

Pattern: .*

Required: No

NodeId

The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

Type: String

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

Pattern: i-[a-f0-9]{8}(?:[a-f0-9]{9})?

Required: No

ResourceType

The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

Type: String

Valid Values: Cluster | InstanceGroup | Instance

Required: No

SortBy

The field to use for sorting the event list. Currently, the only supported value is EventTime.

Type: String

Valid Values: EventTime

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

Response Syntax


{
   "Events": [ 
      { 
         "ClusterArn": "string",
         "ClusterName": "string",
         "Description": "string",
         "EventId": "string",
         "EventTime": number,
         "InstanceGroupName": "string",
         "InstanceId": "string",
         "ResourceType": "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.

Events

A list of event summaries matching the specified criteria.

Type: Array of ClusterEventSummary objects

Array Members: Minimum number of 0 items. Maximum number of 100 items.

NextToken

A token to retrieve the next set of results. Include this token in subsequent ListClusterEvents calls to fetch more events.

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

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400