Describe Events
rds_describe_events | R Documentation |
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¶
Description¶
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.
Usage¶
rds_describe_events(SourceIdentifier, SourceType, StartTime, EndTime,
Duration, EventCategories, Filters, MaxRecords, Marker)
Arguments¶
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 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.
SourceType
The event source to retrieve events for. If no value is specified, all events are returned.
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
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
Duration
The number of minutes to retrieve events for.
Default: 60
EventCategories
A list of event categories that trigger notifications for a event notification subscription.
Filters
This parameter isn't currently supported.
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 you can retrieve the remaining results.Default: 100
Constraints: Minimum 20, maximum 100.
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
.
Value¶
A list with the following syntax:
list(
Marker = "string",
Events = list(
list(
SourceIdentifier = "string",
SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|"custom-engine-version"|"db-proxy"|"blue-green-deployment",
Message = "string",
EventCategories = list(
"string"
),
Date = as.POSIXct(
"2015-01-01"
),
SourceArn = "string"
)
)
)
Request syntax¶
svc$describe_events(
SourceIdentifier = "string",
SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|"custom-engine-version"|"db-proxy"|"blue-green-deployment",
StartTime = as.POSIXct(
"2015-01-01"
),
EndTime = as.POSIXct(
"2015-01-01"
),
Duration = 123,
EventCategories = list(
"string"
),
Filters = list(
list(
Name = "string",
Values = list(
"string"
)
)
),
MaxRecords = 123,
Marker = "string"
)