DocDB / Client / describe_events

describe_events

DocDB.Client.describe_events(**kwargs)

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

See also: AWS API Documentation

Request Syntax

response = client.describe_events(
    SourceIdentifier='string',
    SourceType='db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Duration=123,
    EventCategories=[
        'string',
    ],
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

• SourceIdentifier (string) –

  The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.

  Constraints:

  • If SourceIdentifier is provided, SourceType must also be provided.

  • If the source type is DBInstance, a DBInstanceIdentifier must be provided.

  • If the source type is DBSecurityGroup, a DBSecurityGroupName must be provided.

  • If the source type is DBParameterGroup, a DBParameterGroupName must be provided.

  • If the source type is DBSnapshot, a DBSnapshotIdentifier must be provided.

  • Cannot end with a hyphen or contain two consecutive hyphens.

• 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: 2009-07-08T18:00Z

• EndTime (datetime) –

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

  Example: 2009-07-08T18:00Z

• Duration (integer) –

  The number of minutes to retrieve events for.

  Default: 60

• EventCategories (list) –

  A list of event categories that trigger notifications for an event notification subscription.

  • (string) –

• Filters (list) –

  This parameter is not currently supported.

  • (dict) –

    A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

    Wildcards are not supported in filters.

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case sensitive.

      • (string) –

• MaxRecords (integer) –

  The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• Marker (string) – An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'Events': [
        {
            'SourceIdentifier': 'string',
            'SourceType': 'db-instance'|'db-parameter-group'|'db-security-group'|'db-snapshot'|'db-cluster'|'db-cluster-snapshot',
            'Message': 'string',
            'EventCategories': [
                'string',
            ],
            'Date': datetime(2015, 1, 1),
            'SourceArn': 'string'
        },
    ]
}

Response Structure

• (dict) –

  Represents the output of DescribeEvents.

  • Marker (string) –

    An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • Events (list) –

    Detailed information about one or more events.

    • (dict) –

      Detailed information about an event.

      • SourceIdentifier (string) –

        Provides the identifier for the source of the event.

      • SourceType (string) –

        Specifies the source type for this event.

      • Message (string) –

        Provides the text of this event.

      • EventCategories (list) –

        Specifies the category for the event.

        • (string) –

      • Date (datetime) –

        Specifies the date and time of the event.

      • SourceArn (string) –

        The Amazon Resource Name (ARN) for the event.