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

rds-describe-event-subscriptions

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

Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.

If you specify a subscription-name, lists the description for that subscription.

Syntax

rds-describe-event-subscriptions [subscription-name]

[General Options]

Options

Name Description Required

--subscription-name value

The name of the subscription.

This parameter is the default parameter and can be passed as the first value in the command and without a parameter name, for example: rds-describe-event-subscriptions my-subscription-name.

Type: String

Constraints: The name must be less than 255 characters.

Example: --subscription-name mysubscription1

No

Output

The command returns a list of event subscriptions, each with 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.

  • CustSubscriptionId—the Id of the event subscription

  • CustomerAwsId—the AWS customer account associated with the Amazon RDS event notification subscription

  • Enabled—a Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled

  • EventCategoriesList—a list of event categories for the Amazon RDS event notification subscription

  • SnsTopicArn—the Amazon SNS topic's ARN for the Amazon RDS event notification subscription

  • SourceIdsList—a list of source Ids for the Amazon RDS event notification subscription

  • SourceType—the source type for the Amazon RDS event notification subscription

  • Status—the status of the Amazon RDS event notification subscription. Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist

    The status "no-permission" indicates that Amazon RDS no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

  • SubscriptionCreationTime—the time the Amazon RDS event notification subscription was created

  • Marker—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.

Examples

Describing all event subscriptions

This example lists all subscriptions for the current AWS account.

Copy
PROMPT> rds-describe-event-subscriptions