Describe Events
redshift_describe_events | R Documentation |
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days¶
Description¶
Returns events related to clusters, security groups, snapshots, and parameter groups for the past 14 days. Events specific to a particular cluster, security group, snapshot or parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
Usage¶
redshift_describe_events(SourceIdentifier, SourceType, StartTime,
EndTime, Duration, MaxRecords, Marker)
Arguments¶
SourceIdentifier
The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.
Constraints:
If SourceIdentifier is supplied, SourceType must also be provided.
Specify a cluster identifier when SourceType is
cluster
.Specify a cluster security group name when SourceType is
cluster-security-group
.Specify a cluster parameter group name when SourceType is
cluster-parameter-group
.Specify a cluster snapshot identifier when SourceType is
cluster-snapshot
.
SourceType
The event source to retrieve events for. If no value is specified, all events are returned.
Constraints:
If SourceType is supplied, SourceIdentifier must also be provided.
Specify
cluster
when SourceIdentifier is a cluster identifier.Specify
cluster-security-group
when SourceIdentifier is a cluster security group name.Specify
cluster-parameter-group
when SourceIdentifier is a cluster parameter group name.Specify
cluster-snapshot
when SourceIdentifier is a cluster snapshot identifier.
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 prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.
Default:
60
MaxRecords
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified
MaxRecords
value, a value is returned in amarker
field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.Default:
100
Constraints: minimum 20, maximum 100.
Marker
An optional parameter that specifies the starting point to return a set of response records. When the results of a
describe_events
request exceed the value specified inMaxRecords
, Amazon Web Services returns a value in theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.
Value¶
A list with the following syntax:
list(
Marker = "string",
Events = list(
list(
SourceIdentifier = "string",
SourceType = "cluster"|"cluster-parameter-group"|"cluster-security-group"|"cluster-snapshot"|"scheduled-action",
Message = "string",
EventCategories = list(
"string"
),
Severity = "string",
Date = as.POSIXct(
"2015-01-01"
),
EventId = "string"
)
)
)