ElastiCache / Paginator / DescribeEvents

DescribeEvents#

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

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    SourceIdentifier='string',
    SourceType='cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group'|'user'|'user-group',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Duration=123,
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • SourceIdentifier (string) – The identifier of the event source for which events are returned. If not specified, 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.

    Example: 2017-03-30T07:03:49.555Z

  • EndTime (datetime) –

    The end of the time interval for which to retrieve events, specified in ISO 8601 format.

    Example: 2017-03-30T07:03:49.555Z

  • 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': [
        {
            'SourceIdentifier': 'string',
            'SourceType': 'cache-cluster'|'cache-parameter-group'|'cache-security-group'|'cache-subnet-group'|'replication-group'|'user'|'user-group',
            'Message': 'string',
            'Date': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    Represents the output of a DescribeEvents operation.

    • Events (list) –

      A list of events. Each element in the list contains detailed information about one event.

      • (dict) –

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

        • SourceIdentifier (string) –

          The identifier for the source of the event. For example, if the event occurred at the cluster level, the identifier would be the name of the cluster.

        • SourceType (string) –

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

        • Message (string) –

          The text of the event.

        • Date (datetime) –

          The date and time when the event occurred.

    • NextToken (string) –

      A token to resume pagination.