v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1451299221.6 KB

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 <code>EventStartTime</code> and an <code>EventEndTime</code> 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 <code>DescribeReplay</code> to determine the progress of a replay. The value returned for <code>EventLastReplayedTime</code> indicates the time within the specified time range associated with the last event replayed.

post/#X-Amz-Target=AWSEvents.StartReplay

Headers

X-Amz-Target'AWSEvents.StartReplay' required

Request body

ReplayNamestring required

The name of the replay to start.

Descriptionstring

A description for the replay to start.

EventSourceArnstring required

The ARN of the archive to replay events from.

EventStartTimestring date-time required

A time stamp for the time to start replaying events. Only events that occurred between the <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.

EventEndTimestring date-time required

A time stamp for the time to stop replaying events. Only events that occurred between the <code>EventStartTime</code> and <code>EventEndTime</code> are replayed.

Response

Success

ReplayArnstring

The ARN of the replay.

State'STARTING' | 'RUNNING' | 'CANCELLING' | 'COMPLETED' | 'CANCELLED' | 'FAILED'

The state of the replay.

StateReasonstring

The reason that the replay is in the state.

ReplayStartTimestring date-time

The time at which the replay started.