DescribeEvents
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- Duration
-
The number of minutes to retrieve events for.
Default: 60
Type: Integer
Required: No
- EndTime
-
The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Type: Timestamp
Required: No
- EventCategories.EventCategory.N
-
A list of event categories that trigger notifications for a event notification subscription.
Type: Array of strings
Required: No
- Filters.Filter.N
-
This parameter is not currently supported.
Type: Array of Filter objects
Required: No
- Marker
-
An optional pagination token provided by a previous DescribeEvents request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.Type: String
Required: No
- 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 the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
- SourceIdentifier
-
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 supplied, SourceType must also be provided.
-
If the source type is
DBInstance
, then aDBInstanceIdentifier
must be supplied. -
If the source type is
DBSecurityGroup
, aDBSecurityGroupName
must be supplied. -
If the source type is
DBParameterGroup
, aDBParameterGroupName
must be supplied. -
If the source type is
DBSnapshot
, aDBSnapshotIdentifier
must be supplied. -
Cannot end with a hyphen or contain two consecutive hyphens.
Type: String
Required: No
-
- SourceType
-
The event source to retrieve events for. If no value is specified, all events are returned.
Type: String
Valid Values:
db-instance | db-parameter-group | db-security-group | db-snapshot | db-cluster | db-cluster-snapshot
Required: No
- StartTime
-
The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.
Example: 2009-07-08T18:00Z
Type: Timestamp
Required: No
Response Elements
The following elements are returned by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: