Skip to content

Start Replay

eventbridge_start_replay R Documentation

Starts the specified replay

Description

Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use describe_replay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

Usage

eventbridge_start_replay(ReplayName, Description, EventSourceArn,
  EventStartTime, EventEndTime, Destination)

Arguments

ReplayName

[required] The name of the replay to start.

Description

A description for the replay to start.

EventSourceArn

[required] The ARN of the archive to replay events from.

EventStartTime

[required] A time stamp for the time to start replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

EventEndTime

[required] A time stamp for the time to stop replaying events. Only events that occurred between the EventStartTime and EventEndTime are replayed.

Destination

[required] A ReplayDestination object that includes details about the destination for the replay.

Value

A list with the following syntax: 

list(
  ReplayArn = "string",
  State = "STARTING"|"RUNNING"|"CANCELLING"|"COMPLETED"|"CANCELLED"|"FAILED",
  StateReason = "string",
  ReplayStartTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$start_replay(
  ReplayName = "string",
  Description = "string",
  EventSourceArn = "string",
  EventStartTime = as.POSIXct(
    "2015-01-01"
  ),
  EventEndTime = as.POSIXct(
    "2015-01-01"
  ),
  Destination = list(
    Arn = "string",
    FilterArns = list(
      "string"
    )
  )
)