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

rds-describe-event-categories

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

Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the categories for a given SourceType in the Events topic in the Amazon Relational Database Service User Guide.

Syntax

rds-describe-event-categories

[-s (--source-type) value]

[General Options]

Options

Name Description Required

-s

--source-type value

The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

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

Type: String

No

Output

The command returns a list of event categories and their associated source type.

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.

  • EventCategories—the event categories for the specified source type

  • SourceType—the source type that the returned categories belong to

Examples

Describing the event categories available for RDS event notification subscriptions

This example lists the event categories available for a DB instance source type.

Copy
PROMPT> rds-describe-event-categories --SourceType db-instance