Describe Event Subscriptions

rds_describe_event_subscriptions

R Documentation

Lists all the subscription descriptions for a customer account¶

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 SubscriptionName, lists the description for that subscription.

Usage¶

rds_describe_event_subscriptions(SubscriptionName, Filters, MaxRecords,
  Marker)

Arguments¶

SubscriptionName

The name of the RDS event notification subscription you want to describe.

Filters

This parameter isn't currently supported.

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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Marker

An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords .

Value¶

A list with the following syntax:

list(
  Marker = "string",
  EventSubscriptionsList = list(
    list(
      CustomerAwsId = "string",
      CustSubscriptionId = "string",
      SnsTopicArn = "string",
      Status = "string",
      SubscriptionCreationTime = "string",
      SourceType = "string",
      SourceIdsList = list(
        "string"
      ),
      EventCategoriesList = list(
        "string"
      ),
      Enabled = TRUE|FALSE,
      EventSubscriptionArn = "string"
    )
  )
)

Request syntax¶

svc$describe_event_subscriptions(
  SubscriptionName = "string",
  Filters = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxRecords = 123,
  Marker = "string"
)

Examples¶

## Not run: 
# This example lists information for the specified DB event notification
# subscription.
svc$describe_event_subscriptions(
  SubscriptionName = "mymysqleventsubscription"
)

## End(Not run)