[ aws . rds ]

describe-event-categories

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 event categories and source types in the Events topic in the Amazon RDS User Guide.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-event-categories
[--source-type <value>]
[--filters <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--source-type (string)

The type of source that is generating the events.

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

--filters (list)

This parameter is not currently supported.

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To describe event categories

This example describes the event categories for all available event sources:

aws rds describe-event-categories

Output:

{

"EventCategoriesMapList": [

{

"SourceType": "db-instance", "EventCategories": [

"deletion", "read replica", "failover", "restoration", "maintenance", "low storage", "configuration change", "backup", "creation", "availability", "recovery", "failure", "backtrack", "notification"

]

}, {

"SourceType": "db-security-group", "EventCategories": [

"configuration change", "failure"

]

}, {

"SourceType": "db-parameter-group", "EventCategories": [

"configuration change"

]

}, {

"SourceType": "db-snapshot", "EventCategories": [

"deletion", "creation", "restoration", "notification"

]

}, {

"SourceType": "db-cluster", "EventCategories": [

"failover", "failure", "notification"

]

}, {

"SourceType": "db-cluster-snapshot", "EventCategories": [

"backup"

]

}

]

}

Output

EventCategoriesMapList -> (list)

A list of EventCategoriesMap data types.

(structure)

Contains the results of a successful invocation of the DescribeEventCategories action.

SourceType -> (string)

The source type that the returned categories belong to

EventCategories -> (list)

The event categories for the specified source type

(string)