List Replays

eventbridge_list_replays

R Documentation

Lists your replays

Description

Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

Usage

eventbridge_list_replays(NamePrefix, State, EventSourceArn, NextToken,
  Limit)

Arguments

NamePrefix

A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

State

The state of the replay.

EventSourceArn

The ARN of the archive from which the events are replayed.

NextToken

The token returned by a previous call, which you can use to retrieve the next set of results.

The value of nextToken is a unique pagination token for each page. To retrieve the next page of results, make the call again using the returned token. Keep all other arguments unchanged.

Using an expired pagination token results in an ⁠HTTP 400 InvalidToken⁠ error.

Limit

The maximum number of replays to retrieve.

Value

A list with the following syntax:

list(
  Replays = list(
    list(
      ReplayName = "string",
      EventSourceArn = "string",
      State = "STARTING"|"RUNNING"|"CANCELLING"|"COMPLETED"|"CANCELLED"|"FAILED",
      StateReason = "string",
      EventStartTime = as.POSIXct(
        "2015-01-01"
      ),
      EventEndTime = as.POSIXct(
        "2015-01-01"
      ),
      EventLastReplayedTime = as.POSIXct(
        "2015-01-01"
      ),
      ReplayStartTime = as.POSIXct(
        "2015-01-01"
      ),
      ReplayEndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_replays(
  NamePrefix = "string",
  State = "STARTING"|"RUNNING"|"CANCELLING"|"COMPLETED"|"CANCELLED"|"FAILED",
  EventSourceArn = "string",
  NextToken = "string",
  Limit = 123
)