Menu
Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DescribeEvents

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

Duration

The number of minutes to retrieve events for.

Default: 60

Type: Integer

Required: No

EndTime

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

Type: Timestamp

Required: No

EventCategories.EventCategory.N

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

Type: Array of strings

Required: No

Filters.Filter.N

This parameter is not currently supported.

Type: Array of Filter objects

Required: No

Marker

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.

Type: String

Required: No

MaxRecords

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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

SourceIdentifier

The identifier of the event source for which events will be 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 DBInstance, then a DBInstanceIdentifier must be supplied.

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

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

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

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

Type: String

Required: No

SourceType

The event source to retrieve events for. If no value is specified, all events are returned.

Type: String

Valid Values: db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot

Required: No

StartTime

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

Type: Timestamp

Required: No

Response Elements

The following elements are returned by the service.

Events.Event.N

A list of Event instances.

Type: Array of Event objects

Marker

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 .

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

Example

Sample Request

Copy
https://rds.us-west-2.amazonaws.com/ ?Action=DescribeEvents &Duration=1440 &MaxRecords=100 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request &X-Amz-Date=20140421T194733Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=8e313cabcdbd9766c56a2886b5b298fd944e0b7cfa248953c82705fdd0374f27

Sample Response

Copy
<DescribeEventsResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <DescribeEventsResult> <Events> <Event> <Message>Backing up DB instance</Message> <SourceType>db-instance</SourceType> <EventCategories> <EventCategory>backup</EventCategory> </EventCategories> <Date>2014-04-21T06:23:33.866Z</Date> <SourceIdentifier>mypgdbinstance</SourceIdentifier> </Event> <Event> <Message>Finished DB Instance backup</Message> <SourceType>db-instance</SourceType> <EventCategories> <EventCategory>backup</EventCategory> </EventCategories> <Date>2014-04-21T06:25:03.928Z</Date> <SourceIdentifier>mypgdbinstance</SourceIdentifier> </Event> <Event> <Message>Backing up DB instance</Message> <SourceType>db-instance</SourceType> <EventCategories> <EventCategory>backup</EventCategory> </EventCategories> <Date>2014-04-21T07:09:34.594Z</Date> <SourceIdentifier>my-mysqlexampledb4</SourceIdentifier> </Event> <Event> <Message>Finished DB Instance backup</Message> <SourceType>db-instance</SourceType> <EventCategories> <EventCategory>backup</EventCategory> </EventCategories> <Date>2014-04-21T07:11:05.640Z</Date> <SourceIdentifier>my-mysqlexampledb4</SourceIdentifier> </Event> <Event> <Message>Backing up DB instance</Message> <SourceType>db-instance</SourceType> <EventCategories> <EventCategory>backup</EventCategory> </EventCategories> <Date>2014-04-21T09:26:25.988Z</Date> <SourceIdentifier>my-oracledb1</SourceIdentifier> </Event> <Event> <Message>Finished DB Instance backup</Message> <SourceType>db-instance</SourceType> <EventCategories> <EventCategory>backup</EventCategory> </EventCategories> <Date>2014-04-21T09:28:38.048Z</Date> <SourceIdentifier>my-oracledb1</SourceIdentifier> </Event> </Events> </DescribeEventsResult> <ResponseMetadata> <RequestId>b7a8cd43-b98c-11d3-a907-5a2c468b9cb0</RequestId> </ResponseMetadata> </DescribeEventsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: