OpsWorksCM / Paginator / DescribeEvents

DescribeEvents

class OpsWorksCM.Paginator.DescribeEvents

paginator = client.get_paginator('describe_events')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ServerName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ServerName (string) –

  [REQUIRED]

  The name of the server for which you want to view events.

• 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

{
    'ServerEvents': [
        {
            'CreatedAt': datetime(2015, 1, 1),
            'ServerName': 'string',
            'Message': 'string',
            'LogUrl': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • ServerEvents (list) –

    Contains the response to a DescribeEvents request.

    • (dict) –

      An event that is related to the server, such as the start of maintenance or backup.

      • CreatedAt (datetime) –

        The time when the event occurred.

      • ServerName (string) –

        The name of the server on or for which the event occurred.

      • Message (string) –

        A human-readable informational or status message.

      • LogUrl (string) –

        The Amazon S3 URL of the event’s log file.