Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-events
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Events
describe-events
[--source-identifier <value>]
[--source-type <value>]
[--start-time <value>]
[--end-time <value>]
[--duration <value>]
[--event-categories <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--source-identifier
(string)
The identifier of the event source for which events are returned. If not specified, then all sources are included in the response.
Constraints:
If
SourceIdentifier
is provided,SourceType
must also be provided.If the source type is
DBInstance
, aDBInstanceIdentifier
must be provided.If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be provided.If the source type is
DBParameterGroup
, aDBParameterGroupName
must be provided.If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be provided.Cannot end with a hyphen or contain two consecutive hyphens.
--source-type
(string)
The event source to retrieve events for. If no value is specified, all events are returned.
Possible values:
db-instance
db-parameter-group
db-security-group
db-snapshot
db-cluster
db-cluster-snapshot
--start-time
(timestamp)
The beginning of the time interval to retrieve events for, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
--end-time
(timestamp)
The end of the time interval for which to retrieve events, specified in ISO 8601 format.
Example: 2009-07-08T18:00Z
--duration
(integer)
The number of minutes to retrieve events for.
Default: 60
--event-categories
(list)
A list of event categories that trigger notifications for an event notification subscription.
(string)
Syntax:
"string" "string" ...
--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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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 list Amazon DocumentDB events
The following describe-events
example list all the Amazon DocumentDB events for the last 24 hours (1440 minutes).
aws docdb describe-events \
--duration 1440
This command produces no output. Output:
{
"Events": [
{
"EventCategories": [
"failover"
],
"Message": "Started cross AZ failover to DB instance: sample-cluster",
"Date": "2019-03-18T21:36:29.807Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"SourceIdentifier": "sample-cluster",
"SourceType": "db-cluster"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-18T21:36:40.793Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster",
"SourceIdentifier": "sample-cluster",
"SourceType": "db-instance"
},
{
"EventCategories": [],
"Message": "A new writer was promoted. Restarting database as a reader.",
"Date": "2019-03-18T21:36:43.873Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-18T21:36:51.257Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"failover"
],
"Message": "Completed failover to DB instance: sample-cluster",
"Date": "2019-03-18T21:36:53.462Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:cluster:sample-cluster",
"SourceIdentifier": "sample-cluster",
"SourceType": "db-cluster"
},
{
"Date": "2019-03-19T16:51:48.847Z",
"EventCategories": [
"configuration change"
],
"Message": "Updated parameter audit_logs to enabled with apply method pending-reboot",
"SourceIdentifier": "custom3-6-param-grp",
"SourceType": "db-parameter-group"
},
{
"EventCategories": [
"configuration change"
],
"Message": "Applying modification to database instance class",
"Date": "2019-03-19T17:55:20.095Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance shutdown",
"Date": "2019-03-19T17:56:31.127Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"configuration change"
],
"Message": "Finished applying modification to DB instance class",
"Date": "2019-03-19T18:00:45.822Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-19T18:00:53.397Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance shutdown",
"Date": "2019-03-19T18:23:36.045Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"EventCategories": [
"availability"
],
"Message": "DB instance restarted",
"Date": "2019-03-19T18:23:46.209Z",
"SourceArn": "arn:aws:rds:us-west-2:123456789012:db:sample-cluster2",
"SourceIdentifier": "sample-cluster2",
"SourceType": "db-instance"
},
{
"Date": "2019-03-19T18:39:05.822Z",
"EventCategories": [
"configuration change"
],
"Message": "Updated parameter ttl_monitor to enabled with apply method immediate",
"SourceIdentifier": "custom3-6-param-grp",
"SourceType": "db-parameter-group"
},
{
"Date": "2019-03-19T18:39:48.067Z",
"EventCategories": [
"configuration change"
],
"Message": "Updated parameter audit_logs to disabled with apply method immediate",
"SourceIdentifier": "custom3-6-param-grp",
"SourceType": "db-parameter-group"
}
]
}
For more information, see Viewing Amazon DocumentDB Events in the Amazon DocumentDB Developer Guide.
Marker -> (string)
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
.
Events -> (list)
Detailed information about one or more events.
(structure)
Detailed information about an event.
SourceIdentifier -> (string)
Provides the identifier for the source of the event.
SourceType -> (string)
Specifies the source type for this event.
Message -> (string)
Provides the text of this event.
EventCategories -> (list)
Specifies the category for the event.
(string)
Date -> (timestamp)
Specifies the date and time of the event.
SourceArn -> (string)
The Amazon Resource Name (ARN) for the event.