Lightsail / Paginator / GetRelationalDatabaseEvents

GetRelationalDatabaseEvents

class Lightsail.Paginator.GetRelationalDatabaseEvents

paginator = client.get_paginator('get_relational_database_events')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Lightsail.Client.get_relational_database_events().

See also: AWS API Documentation

Request Syntax

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

Parameters:

• relationalDatabaseName (string) –

  [REQUIRED]

  The name of the database from which to get events.

• durationInMinutes (integer) –

  The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120.

  Default: 60

  The minimum is 1 and the maximum is 14 days (20160 minutes).

• 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.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'relationalDatabaseEvents': [
        {
            'resource': 'string',
            'createdAt': datetime(2015, 1, 1),
            'message': 'string',
            'eventCategories': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • relationalDatabaseEvents (list) –

    An object describing the result of your get relational database events request.

    • (dict) –

      Describes an event for a database.

      • resource (string) –

        The database that the database event relates to.

      • createdAt (datetime) –

        The timestamp when the database event was created.

      • message (string) –

        The message of the database event.

      • eventCategories (list) –

        The category that the database event belongs to.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.