List Cluster Events

sagemaker_list_cluster_events

R Documentation

Retrieves a list of event summaries for a specified HyperPod cluster¶

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.

Usage¶

sagemaker_list_cluster_events(ClusterName, InstanceGroupName, NodeId,
  EventTimeAfter, EventTimeBefore, SortBy, SortOrder, ResourceType,
  MaxResults, NextToken)

Arguments¶

ClusterName

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

InstanceGroupName

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

NodeId

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

EventTimeAfter

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

EventTimeBefore

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

SortBy

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

SortOrder

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

ResourceType

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

MaxResults

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

NextToken

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

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  Events = list(
    list(
      EventId = "string",
      ClusterArn = "string",
      ClusterName = "string",
      InstanceGroupName = "string",
      InstanceId = "string",
      ResourceType = "Cluster"|"InstanceGroup"|"Instance",
      EventTime = as.POSIXct(
        "2015-01-01"
      ),
      Description = "string",
      EventLevel = "Info"|"Warn"|"Error"
    )
  )
)

Request syntax¶

svc$list_cluster_events(
  ClusterName = "string",
  InstanceGroupName = "string",
  NodeId = "string",
  EventTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  EventTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "EventTime",
  SortOrder = "Ascending"|"Descending",
  ResourceType = "Cluster"|"InstanceGroup"|"Instance",
  MaxResults = 123,
  NextToken = "string"
)