list-cluster-events¶

Description¶

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 .

Synopsis¶

  list-cluster-events
--cluster-name <value>
[--instance-group-name <value>]
[--node-id <value>]
[--event-time-after <value>]
[--event-time-before <value>]
[--sort-by <value>]
[--sort-order <value>]
[--resource-type <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--cluster-name (string)

The name or Amazon Resource Name (ARN) of the HyperPod cluster for which to list events.

--instance-group-name (string)

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

--node-id (string)

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

--event-time-after (timestamp)

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

--event-time-before (timestamp)

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

--sort-by (string)

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

Possible values:

EventTime

--sort-order (string)

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

Possible values:

Ascending

Descending

--resource-type (string)

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

Possible values:

Cluster

InstanceGroup

Instance

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

NextToken -> (string)

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

Events -> (list)

A list of event summaries matching the specified criteria.

(structure)

A summary of an event in a HyperPod cluster.

EventId -> (string)

The unique identifier (UUID) of the event.

ClusterArn -> (string)

The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.

ClusterName -> (string)

The name of the HyperPod cluster associated with the event.

InstanceGroupName -> (string)

The name of the instance group associated with the event, if applicable.

InstanceId -> (string)

The Amazon Elastic Compute Cloud (EC2) instance ID associated with the event, if applicable.

ResourceType -> (string)

The type of resource associated with the event. Valid values are Cluster , InstanceGroup , or Instance .

EventTime -> (timestamp)

The timestamp when the event occurred.

Description -> (string)

A brief, human-readable description of the event.

Table of Contents

Feedback

User Guide