[ aws . sagemaker ]

describe-cluster-event

Description

Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous .

See also: AWS API Documentation

Synopsis

  describe-cluster-event
--event-id <value>
--cluster-name <value>
[--cli-input-json | --cli-input-yaml]
[--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

--event-id (string)

The unique identifier (UUID) of the event to describe. This ID can be obtained from the ListClusterEvents operation.

--cluster-name (string)

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

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

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

EventDetails -> (structure)

Detailed information about the requested cluster event, including event metadata for various resource types such as Cluster , InstanceGroup , Instance , and their associated attributes.

EventId -> (string)

The unique identifier (UUID) of the event.

ClusterArn -> (string)

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

ClusterName -> (string)

The name of the SageMaker HyperPod cluster associated with the event.

InstanceGroupName -> (string)

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

InstanceId -> (string)

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

EventDetails -> (structure)

Additional details about the event, including event-specific metadata.

EventMetadata -> (tagged union structure)

Metadata specific to the event, which may include information about the cluster, instance group, or instance involved.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: Cluster, InstanceGroup, InstanceGroupScaling, Instance.

Cluster -> (structure)

Metadata specific to cluster-level events.

FailureMessage -> (string)

An error message describing why the cluster level operation (such as creating, updating, or deleting) failed.

EksRoleAccessEntries -> (list)

A list of Amazon EKS IAM role ARNs associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.

(string)

SlrAccessEntry -> (string)

The Service-Linked Role (SLR) associated with the cluster. This is created by SageMaker HyperPod on your behalf and only applies for EKS-orchestrated clusters.

InstanceGroup -> (structure)

Metadata specific to instance group-level events.

FailureMessage -> (string)

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

AvailabilityZoneId -> (string)

The ID of the Availability Zone where the instance group is located.

CapacityReservation -> (structure)

Information about the Capacity Reservation used by the instance group.

Arn -> (string)

The Amazon Resource Name (ARN) of the Capacity Reservation.

Type -> (string)

The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).

SubnetId -> (string)

The ID of the subnet where the instance group is located.

SecurityGroupIds -> (list)

A list of security group IDs associated with the instance group.

(string)

AmiOverride -> (string)

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

InstanceGroupScaling -> (structure)

Metadata related to instance group scaling events.

InstanceCount -> (integer)

The current number of instances in the group.

TargetCount -> (integer)

The desired number of instances for the group after scaling.

FailureMessage -> (string)

An error message describing why the scaling operation failed, if applicable.

Instance -> (structure)

Metadata specific to instance-level events.

CustomerEni -> (string)

The ID of the customer-managed Elastic Network Interface (ENI) associated with the instance.

AdditionalEnis -> (structure)

Information about additional Elastic Network Interfaces (ENIs) associated with the instance.

EfaEnis -> (list)

A list of Elastic Fabric Adapter (EFA) ENIs associated with the instance.

(string)

CapacityReservation -> (structure)

Information about the Capacity Reservation used by the instance.

Arn -> (string)

The Amazon Resource Name (ARN) of the Capacity Reservation.

Type -> (string)

The type of Capacity Reservation. Valid values are ODCR (On-Demand Capacity Reservation) or CRG (Capacity Reservation Group).

FailureMessage -> (string)

An error message describing why the instance creation or update failed, if applicable.

LcsExecutionState -> (string)

The execution state of the Lifecycle Script (LCS) for the instance.

NodeLogicalId -> (string)

The unique logical identifier of the node within the cluster. The ID used here is the same object as in the BatchAddClusterNodes API.

Description -> (string)

A human-readable description of the event.