DescribeReplay
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.
Request Syntax
{
"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.
- ReplayName
-
The name of the replay to retrieve.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+Required: Yes
Response Syntax
{
"Description": "string",
"Destination": {
"Arn": "string",
"FilterArns": [ "string" ]
},
"EventEndTime": number,
"EventLastReplayedTime": number,
"EventSourceArn": "string",
"EventStartTime": number,
"ReplayArn": "string",
"ReplayEndTime": number,
"ReplayName": "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.
- Description
-
The description of the replay.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
.* - Destination
-
A
ReplayDestinationobject that contains details about the replay.Type: ReplayDestination object
- EventEndTime
-
The time stamp for the last event that was replayed from the archive.
Type: Timestamp
- EventLastReplayedTime
-
The time that the event was last replayed.
Type: Timestamp
- EventSourceArn
-
The ARN of the archive events were replayed from.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
- EventStartTime
-
The time stamp of the first event that was last replayed from the archive.
Type: Timestamp
- 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]+$ - ReplayEndTime
-
A time stamp for the time that the replay stopped.
Type: Timestamp
- ReplayName
-
The name of the replay.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\.\-_A-Za-z0-9]+ - ReplayStartTime
-
A time stamp for the time that the replay started.
Type: Timestamp
- State
-
The current state of the replay.
Type: String
Valid Values:
STARTING | RUNNING | CANCELLING | COMPLETED | CANCELLED | FAILED - StateReason
-
The reason that the replay is in the current 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
- ResourceNotFoundException
-
An entity that you specified does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
