DAX / Paginator / DescribeEvents

DescribeEvents#

class DAX.Paginator.DescribeEvents#
paginator = client.get_paginator('describe_events')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DAX.Client.describe_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SourceName='string',
    SourceType='CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Duration=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • SourceName (string) – The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.

  • SourceType (string) – The event source to retrieve events for. If no value is specified, all events are returned.

  • StartTime (datetime) – The beginning of the time interval to retrieve events for, specified in ISO 8601 format.

  • EndTime (datetime) – The end of the time interval for which to retrieve events, specified in ISO 8601 format.

  • Duration (integer) – The number of minutes’ worth of events to retrieve.

  • 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': [
        {
            'SourceName': 'string',
            'SourceType': 'CLUSTER'|'PARAMETER_GROUP'|'SUBNET_GROUP',
            'Message': 'string',
            'Date': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • Events (list) –

      An array of events. Each element in the array represents one event.

      • (dict) –

        Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.

        • SourceName (string) –

          The source of the event. For example, if the event occurred at the node level, the source would be the node ID.

        • SourceType (string) –

          Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.

        • Message (string) –

          A user-defined message associated with the event.

        • Date (datetime) –

          The date and time when the event occurred.