v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1456332247.5 KB

Retrieves details about a replay. Use <code>DescribeReplay</code> to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use <code>StartReplay</code> and 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.DescribeReplay

Headers

X-Amz-Target'AWSEvents.DescribeReplay' required

Request body

ReplayNamestring required

The name of the replay to retrieve.

Response

Success

ReplayNamestring

The name of the replay.

ReplayArnstring

The ARN of the replay.

Descriptionstring

The description of the replay.

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

The current state of the replay.

StateReasonstring

The reason that the replay is in the current state.

EventSourceArnstring

The ARN of the archive events were replayed from.

EventStartTimestring date-time

The time stamp of the first event that was last replayed from the archive.

EventEndTimestring date-time

The time stamp for the last event that was replayed from the archive.

EventLastReplayedTimestring date-time

The time that the event was last replayed.

ReplayStartTimestring date-time

A time stamp for the time that the replay started.

ReplayEndTimestring date-time

A time stamp for the time that the replay stopped.