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 Events in the Amazon RDS User Guide.
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-cluster
|db-parameter-group
|db-security-group
|db-snapshot
|db-cluster-snapshot
--filters
(list)
This parameter isn’t currently supported.
(structure)
A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.
Note
Currently, wildcards are not supported in filters.
The following actions can be filtered:
DescribeDBClusterBacktracks
DescribeDBClusterEndpoints
DescribeDBClusters
DescribeDBInstances
DescribePendingMaintenanceActions
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 event categories
The following describe-event-categories
example retrieves details about 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"
]
}
]
}
EventCategoriesMapList -> (list)
A list of EventCategoriesMap data types.
(structure)
Contains the results of a successful invocation of the
DescribeEventCategories
operation.SourceType -> (string)
The source type that the returned categories belong to
EventCategories -> (list)
The event categories for the specified source type
(string)