Skip to content

Describe Events

memorydb_describe_events R Documentation

Description

Returns events related to clusters, security groups, and parameter groups. You can obtain events specific to a particular cluster, security group, or 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

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

Arguments

SourceName

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.

MaxResults

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

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  Events = list(
    list(
      SourceName = "string",
      SourceType = "node"|"parameter-group"|"subnet-group"|"cluster"|"user"|"acl",
      Message = "string",
      Date = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax

svc$describe_events(
  SourceName = "string",
  SourceType = "node"|"parameter-group"|"subnet-group"|"cluster"|"user"|"acl",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  Duration = 123,
  MaxResults = 123,
  NextToken = "string"
)