Displays a list of categories for all event source types, or, if specified, for a specified source type.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-event-categories
[--source-type <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--source-type
(string)
The type of source that is generating the events.
Valid values:
db-instance
,db-parameter-group
,db-security-group
--filters
(list)
This parameter is not currently supported.
(structure)
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name -> (string)
The name of the filter. Filter names are case sensitive.
Values -> (list)
One or more filter values. Filter values are case sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml
.
--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
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. 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.
To describe all Amazon DocumentDB event categories
The following describe-event-categories
example lists all categories for the Amazon DocumentDB event source type db-instance
.
aws docdb describe-event-categories \
--source-type db-cluster
Output:
{
"EventCategoriesMapList": [
{
"SourceType": "db-cluster",
"EventCategories": [
"failover",
"maintenance",
"notification",
"failure"
]
}
]
}
For more information, see Viewing Event Categories in the Amazon DocumentDB Developer Guide.
EventCategoriesMapList -> (list)
A list of event category maps.
(structure)
An event source type, accompanied by one or more event category names.
SourceType -> (string)
The source type that the returned categories belong to.
EventCategories -> (list)
The event categories for the specified source type.
(string)