SageMaker / Paginator / ListClusterEvents

ListClusterEvents

class SageMaker.Paginator.ListClusterEvents

paginator = client.get_paginator('list_cluster_events')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_cluster_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ClusterName='string',
    InstanceGroupName='string',
    NodeId='string',
    EventTimeAfter=datetime(2015, 1, 1),
    EventTimeBefore=datetime(2015, 1, 1),
    SortBy='EventTime',
    SortOrder='Ascending'|'Descending',
    ResourceType='Cluster'|'InstanceGroup'|'Instance',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ClusterName (string) –

  [REQUIRED]

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

• InstanceGroupName (string) – The name of the instance group to filter events. If specified, only events related to this instance group are returned.

• NodeId (string) – The EC2 instance ID to filter events. If specified, only events related to this instance are returned.

• EventTimeAfter (datetime) – The start of the time range for filtering events. Only events that occurred after this time are included in the results.

• EventTimeBefore (datetime) – The end of the time range for filtering events. Only events that occurred before this time are included in the results.

• SortBy (string) – The field to use for sorting the event list. Currently, the only supported value is EventTime.

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

• ResourceType (string) – The type of resource for which to filter events. Valid values are Cluster, InstanceGroup, or Instance.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'Events': [
        {
            'EventId': 'string',
            'ClusterArn': 'string',
            'ClusterName': 'string',
            'InstanceGroupName': 'string',
            'InstanceId': 'string',
            'ResourceType': 'Cluster'|'InstanceGroup'|'Instance',
            'EventTime': datetime(2015, 1, 1),
            'Description': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Events (list) –

    A list of event summaries matching the specified criteria.

    • (dict) –

      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 (datetime) –

        The timestamp when the event occurred.

      • Description (string) –

        A brief, human-readable description of the event.