Describe Events

elasticache_describe_events

R Documentation

Description¶

Returns events related to clusters, cache security groups, and cache parameter groups. You can obtain events specific to a particular cluster, cache security group, or cache parameter group by providing the name as a parameter.

By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.

Usage¶

elasticache_describe_events(SourceIdentifier, SourceType, StartTime,
  EndTime, Duration, MaxRecords, Marker)

Arguments¶

SourceIdentifier

The identifier of the event source for which events are returned. If not specified, all sources are included in the response.

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.

Example: 2017-03-30T07:03:49.555Z

EndTime

The end of the time interval for which to retrieve events, specified in ISO 8601 format.

Example: 2017-03-30T07:03:49.555Z

Duration

The number of minutes worth of events to retrieve.

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, 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 marker returned from a prior request. Use this marker for pagination of results from this operation. 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 = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|"serverless-cache"|"serverless-cache-snapshot"|"user"|"user-group",
      Message = "string",
      Date = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$describe_events(
  SourceIdentifier = "string",
  SourceType = "cache-cluster"|"cache-parameter-group"|"cache-security-group"|"cache-subnet-group"|"replication-group"|"serverless-cache"|"serverless-cache-snapshot"|"user"|"user-group",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Duration = 123,
  MaxRecords = 123,
  Marker = "string"
)

Examples¶

## Not run: 
# Describes all the cache-cluster events for the past 120 minutes.
svc$describe_events(
  Duration = 360L,
  SourceType = "cache-cluster"
)

# Describes all the replication-group events from 3:00P to 5:00P on
# November 11, 2016.
svc$describe_events(
  StartTime = "2016-12-22T15:00:00.000Z"
)

## End(Not run)