Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartReplay

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 DescribeReplay 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.

Request Syntax


{
   "Description": "string",
   "Destination": { 
      "Arn": "string",
      "FilterArns": [ "string" ]
   },
   "EventEndTime": number,
   "EventSourceArn": "string",
   "EventStartTime": number,
   "ReplayName": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Description

A description for the replay to start.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Required: No

Destination

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

Type: ReplayDestination object

Required: Yes

EventEndTime

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

Type: Timestamp

Required: Yes

EventSourceArn

The ARN of the archive to replay events from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

EventStartTime

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

Type: Timestamp

Required: Yes

ReplayName

The name of the replay to start.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes

Response Syntax


{
   "ReplayArn": "string",
   "ReplayStartTime": number,
   "State": "string",
   "StateReason": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ReplayArn

The ARN of the replay.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws([a-z]|\-)*:events:([a-z]|\d|\-)*:([0-9]{12})?:.+\/[\.\-_A-Za-z0-9]+$

ReplayStartTime

The time at which the replay started.

Type: Timestamp

State

The state of the replay.

Type: String

StateReason

The reason that the replay is in the state.

Type: String

Length Constraints: Maximum length of 512.

Pattern: .*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalException

This exception occurs due to unexpected causes.

HTTP Status Code: 500

InvalidEventPatternException

The event pattern is not valid.

HTTP Status Code: 400

LimitExceededException

The request failed because it attempted to create resource beyond the allowed service quota.

HTTP Status Code: 400

ResourceAlreadyExistsException

The resource you are trying to create already exists.

HTTP Status Code: 400

ResourceNotFoundException

An entity that you specified does not exist.

HTTP Status Code: 400