/AWS1/CL_RDS=>DESCRIBEEVENTS()
¶
About DescribeEvents¶
Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide.
By default, RDS returns events that were generated in the past hour.
Method Signature¶
IMPORTING¶
Optional arguments:¶
IV_SOURCEIDENTIFIER
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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 a DB instance, a
DBInstanceIdentifier
value must be supplied.If the source type is a DB cluster, a
DBClusterIdentifier
value must be supplied.If the source type is a DB parameter group, a
DBParameterGroupName
value must be supplied.If the source type is a DB security group, a
DBSecurityGroupName
value must be supplied.If the source type is a DB snapshot, a
DBSnapshotIdentifier
value must be supplied.If the source type is a DB cluster snapshot, a
DBClusterSnapshotIdentifier
value must be supplied.If the source type is an RDS Proxy, a
DBProxyName
value must be supplied.Can't end with a hyphen or contain two consecutive hyphens.
IV_SOURCETYPE
TYPE /AWS1/RDSSOURCETYPE
/AWS1/RDSSOURCETYPE
¶
The event source to retrieve events for. If no value is specified, all events are returned.
IV_STARTTIME
TYPE /AWS1/RDSTSTAMP
/AWS1/RDSTSTAMP
¶
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
IV_ENDTIME
TYPE /AWS1/RDSTSTAMP
/AWS1/RDSTSTAMP
¶
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
IV_DURATION
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
The number of minutes to retrieve events for.
Default: 60
IT_EVENTCATEGORIES
TYPE /AWS1/CL_RDSEVENTCATSLIST_W=>TT_EVENTCATEGORIESLIST
TT_EVENTCATEGORIESLIST
¶
A list of event categories that trigger notifications for a event notification subscription.
IT_FILTERS
TYPE /AWS1/CL_RDSFILTER=>TT_FILTERLIST
TT_FILTERLIST
¶
This parameter isn't currently supported.
IV_MAXRECORDS
TYPE /AWS1/RDSINTEGEROPTIONAL
/AWS1/RDSINTEGEROPTIONAL
¶
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 you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
IV_MARKER
TYPE /AWS1/RDSSTRING
/AWS1/RDSSTRING
¶
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
.