describe_events¶

RDS.Client.describe_events(**kwargs)¶

Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.

For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide .

Note

By default, RDS returns events that were generated in the past hour.

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'|'custom-engine-version'|'db-proxy'|'blue-green-deployment',
    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 supplied, SourceType must also be provided.
- If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
- If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
- If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
- If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
- If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
- If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.
- If the source type is an RDS Proxy, a DBProxyName value must be supplied.
- Can't 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. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z
EndTime (datetime) --
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

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 a event notification subscription.
- (string) --
Filters (list) --
This parameter isn't currently supported.
- (dict) --
  A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
  
  Note
  
  Currently, wildcards are not supported in filters.
  
  The following actions can be filtered:
  - DescribeDBClusterBacktracks
  - DescribeDBClusterEndpoints
  - DescribeDBClusters
  - DescribeDBInstances
  - DescribePendingMaintenanceActions
  - 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 called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.
Marker (string) -- An optional pagination token provided by a previous DescribeEvents 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'|'custom-engine-version'|'db-proxy'|'blue-green-deployment',
            'Message': 'string',
            'EventCategories': [
                'string',
            ],
            'Date': datetime(2015, 1, 1),
            'SourceArn': 'string'
        },
    ]
}

Response Structure

(dict) --

Contains the result of a successful invocation of the DescribeEvents action.
- Marker (string) --
  
  An optional pagination token provided by a previous Events request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .
- Events (list) --
  
  A list of Event instances.
  - (dict) --
    
    This data type is used as a response element in the DescribeEvents action.
    - 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.

Examples

This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).

response = client.describe_events(
    Duration=10080,
    EventCategories=[
        'backup',
    ],
    SourceIdentifier='mymysqlinstance',
    SourceType='db-instance',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}

Table Of Contents

describe_events¶