cluster_events

Creates, updates, deletes, gets or lists a cluster_events resource.

Overview

Name	cluster_events
Type	Resource
Id	aws.sagemaker.cluster_events

Fields

The following fields are returned by SELECT queries:

describe_cluster_event

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:cluster/[a-z0-9]{12}</code>)
cluster_name	string	The name of the HyperPod cluster associated with the event. (pattern: <code>[a-zA-Z0-9](-[a-zA-Z0-9])</code>)
description	string	A human-readable description of the event.
event_details	object	Additional details about the event, including event-specific metadata.
event_id	string	The unique identifier (UUID) of the event. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
event_level	string	The severity level of the event. Valid values are Info, Warn, and Error. (Info, Warn, Error)
event_time	string (date-time)	The timestamp when the event occurred.
instance_group_name	string	The name of the instance group associated with the event, if applicable. (pattern: <code>[a-zA-Z0-9](-[a-zA-Z0-9])</code>)
instance_id	string	The EC2 instance ID associated with the event, if applicable.
resource_type	string	The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance. (Cluster, InstanceGroup, Instance)

list_cluster_events

Name	Datatype	Description
cluster_arn	string	The Amazon Resource Name (ARN) of the HyperPod cluster associated with the event. (pattern: <code>arn:aws[a-z-]:sagemaker:[a-z0-9-]:[0-9]{12}:cluster/[a-z0-9]{12}</code>)
cluster_name	string	The name of the HyperPod cluster associated with the event. (pattern: <code>[a-zA-Z0-9](-[a-zA-Z0-9])</code>)
description	string	A brief, human-readable description of the event.
event_id	string	The unique identifier (UUID) of the event. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
event_level	string	The severity level of the event. Valid values are Info, Warn, and Error. (Info, Warn, Error)
event_time	string (date-time)	The timestamp when the event occurred.
instance_group_name	string	The name of the instance group associated with the event, if applicable. (pattern: <code>[a-zA-Z0-9](-[a-zA-Z0-9])</code>)
instance_id	string	The Amazon Elastic Compute Cloud (EC2) instance ID associated with the event, if applicable.
resource_type	string	The type of resource associated with the event. Valid values are Cluster, InstanceGroup, or Instance. (Cluster, InstanceGroup, Instance)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_cluster_event	select	region		Retrieves detailed information about a specific event for a given HyperPod cluster. This functionality is only supported when the NodeProvisioningMode is set to Continuous.
list_cluster_events	select	region		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_cluster_event

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

SELECT
cluster_arn,
cluster_name,
description,
event_details,
event_id,
event_level,
event_time,
instance_group_name,
instance_id,
resource_type
FROM aws.sagemaker.cluster_events
WHERE region = '{{ region }}' -- required
;

list_cluster_events

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.

SELECT
cluster_arn,
cluster_name,
description,
event_id,
event_level,
event_time,
instance_group_name,
instance_id,
resource_type
FROM aws.sagemaker.cluster_events
WHERE region = '{{ region }}' -- required
;