Skip to content

Describe Events

dax_describe_events R Documentation

Description

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

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

Usage

dax_describe_events(SourceName, SourceType, StartTime, EndTime,
  Duration, MaxResults, NextToken)

Arguments

SourceName

The identifier of the event source for which events will be returned. If not specified, then 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.

EndTime

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

Duration

The number of minutes' worth of events to retrieve.

MaxResults

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

NextToken

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Events = list(
    list(
      SourceName = "string",
      SourceType = "CLUSTER"|"PARAMETER_GROUP"|"SUBNET_GROUP",
      Message = "string",
      Date = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_events(
  SourceName = "string",
  SourceType = "CLUSTER"|"PARAMETER_GROUP"|"SUBNET_GROUP",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Duration = 123,
  MaxResults = 123,
  NextToken = "string"
)