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

rds-describe-events

The Amazon RDS Command Line Interface (RDS CLI) has been deprecated. Instead, use the AWS CLI for RDS. To learn how to download and use the AWS CLI, see AWS Command Line Interface User Guide. For RDS commands available in the AWS CLI, see AWS CLI Reference for Amazon RDS.

The AWS CLI does not currently support the DownloadCompleteDBLogFile REST API action. To download an entire log file at once, rather than in parts using the download-db-log-file-portion command, use the last published RDS CLI and the rds-download-db-logfile command.

Description

Returns information about events related to your DB instances, DB security groups or DB parameter groups.

Syntax

rds-describe-events [--duration value ]

[--start-time value ]

[--end-time value ]

[--source-identifier value ]

[--source-type value ]

[-a (--event-categories) value ]

[General Options]

Options

Name Description Required

--duration value

The number of minutes for which to retrieve events.

Type: Integer

Default: 60

Example: Retrieve the last 90 minutes worth of events:

--duration 90

No

--start-time value

The beginning of the time interval to retrieve events, specified in ISO8601 format. For more information about ISO 8601, go to the ISO8601 format Wikipedia page.

Type: Date

Default: none

Example: --start-time 2009-03-31T10:00:00

No

--end-time value

The end of the time interval to retrieve events, specified in ISO8601 format. For more information about ISO 8601, go to the ISO8601 format Wikipedia page.

Type: Date

Default: none

Example: --start-time 2009-03-31T12:00:00

No

--event-categories value

-a value

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

Type: String list

No

--source-type value

Specifies the event source for which to retrieve events.

Type: String

Valid values: db-instance, db-security-group, db-parameter-group, db-snapshot

Example: --source-type db-instance

No

--source-identifier value

Used with the --source-type parameter to restrict returned events to a specific named source.

Type: String

Default: 60

Example: --source-type db-instance --source-identifier mydbinstance

No

Output

The command returns the following information:

Note

Output values list the possible values returned by CLI commands. Not all values are returned for every call to a command. If a value is null or empty, it will not be included in the command output. For example, CLI commands to create or restore a DB instance will not return the Endpoint Address value because that value is null until the DB instance has finished being created or restored.

  • Source Type—Type of event source

  • Date—Database event date/time, in UTC

  • Source Id—Identifier of the event source

  • Category—Indicates the event category.

  • Message—Event description

Examples

Describe All Events

This example returns all events with column headers.

Copy
PROMPT> rds-describe-events --headers Source Type Date Source Id Message db-instance 2009-03-27 00:28:44 test002 Database instance test002 deleted db-instance 2009-03-27 00:30:08 test003 Database instance test003 deleted db-instance 2009-03-27 00:37:59 test001 Database instance test001 created db-instance 2009-03-27 00:39:05 test0010 Database instance test0010 created db-security-group 2009-03-27 00:39:12 Default Finished applying changes to security group db-security-group 2009-03-27 00:40:22 Default The security group mysourcegroup owned by XXXXXX does not exist; revoking authorization db-security-group 2009-03-27 00:44:44 Default Finished applying changes to security group db-instance 2009-03-27 01:07:53 test0010 Database instance test0010 deleted db-instance 2009-03-27 01:09:09 test02 Database instance test02 deleted db-instance 2009-03-27 01:09:22 test004 Database instance test004 deleted db-instance 2009-03-27 01:09:58 test001 Database instance test001 deleted db-parameter-group 2009-03-27 00:39:12 myconfig DBParameterGroup updated with parameter max_binlog_size to 4096 with apply method Immediate db-snapshot 2009-03-27 01:09:58 snapshotid Deleted user snapshot: snapshotid

Describe Events for a Specified Instance

This example returns only events for a specific DB instance.

Copy
PROMPT> rds-describe-events --source-type db-instance --source-identifier test001 Source Type Date Source Id Message db-instance 2009-03-27 00:37:59 test001 Database instance test001 created db-instance 2009-03-27 01:09:58 test001 Database instance test001 deleted

Describe Events for a Specified Time Interval

This example returns only events for a specific time interval.

Copy
PROMPT> rds-describe-events --start-time 2009-03-20T00:00:00-08:00 --end-time 2009-03-20T23:59:59-08:00