replays

Creates, updates, deletes, gets or lists a replays resource.

Overview

Name	replays
Type	Resource
Id	aws.events.replays

Fields

The following fields are returned by SELECT queries:

describe_replay

Name	Datatype	Description
description	string	The description of the replay. (pattern: <code>.*</code>)
destination	object	A ReplayDestination object that contains details about the replay.
event_end_time	string (date-time)	The time stamp for the last event that was replayed from the archive.
event_last_replayed_time	string (date-time)	The time that the event was last replayed.
event_source_arn	string	The ARN of the archive events were replayed from. (pattern: <code>^arn:aws([a-z]|-):events:([a-z]|\d|-):([0-9]{12})?:.+/.+$</code>)
event_start_time	string (date-time)	The time stamp of the first event that was last replayed from the archive.
replay_arn	string	The ARN of the replay. (pattern: <code>^arn:aws([a-z]|-):events:([a-z]|\d|-):([0-9]{12})?:.+/[.-_A-Za-z0-9]+$</code>)
replay_end_time	string (date-time)	A time stamp for the time that the replay stopped.
replay_name	string	The name of the replay. (pattern: <code>[.-_A-Za-z0-9]+</code>)
replay_start_time	string (date-time)	A time stamp for the time that the replay started.
state	string	The current state of the replay. (STARTING, RUNNING, CANCELLING, COMPLETED, CANCELLED, FAILED)
state_reason	string	The reason that the replay is in the current state. (pattern: <code>.*</code>)

list_replays

Name	Datatype	Description
next_token	string	A token indicating there are more results available. If there are no more results, no token is included in the response. 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.
replays	array	An array of Replay objects that contain information about the replay.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_replay	select	region		Retrieves details about a replay. Use DescribeReplay 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 StartReplay and 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.
list_replays	select	region		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.
cancel_replay	exec	region, ReplayName		Cancels the specified replay.
start_replay	exec	region, ReplayName, EventSourceArn, EventStartTime, EventEndTime		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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_replay

Retrieves details about a replay. Use DescribeReplay 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 StartReplay and 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.

SELECT
description,
destination,
event_end_time,
event_last_replayed_time,
event_source_arn,
event_start_time,
replay_arn,
replay_end_time,
replay_name,
replay_start_time,
state,
state_reason
FROM aws.events.replays
WHERE region = '{{ region }}' -- required
;

list_replays

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.

SELECT
next_token,
replays
FROM aws.events.replays
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

cancel_replay

Cancels the specified replay.

EXEC aws.events.replays.cancel_replay 
@region='{{ region }}' --required 
@@json=
'{
"ReplayName": "{{ ReplayName }}"
}'
;

start_replay

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.

EXEC aws.events.replays.start_replay 
@region='{{ region }}' --required 
@@json=
'{
"ReplayName": "{{ ReplayName }}", 
"Description": "{{ Description }}", 
"EventSourceArn": "{{ EventSourceArn }}", 
"EventStartTime": "{{ EventStartTime }}", 
"EventEndTime": "{{ EventEndTime }}", 
"Destination": "{{ Destination }}"
}'
;