Describe Events
neptune_describe_events | R Documentation |
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days¶
Description¶
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.
Usage¶
neptune_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
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.
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 is not 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 the remaining results can be retrieved.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",
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",
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"
)