- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DescribeReplayCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { EventBridgeClient, DescribeReplayCommand } from "@aws-sdk/client-eventbridge"; // ES Modules import
// const { EventBridgeClient, DescribeReplayCommand } = require("@aws-sdk/client-eventbridge"); // CommonJS import
const client = new EventBridgeClient(config);
const input = { // DescribeReplayRequest
ReplayName: "STRING_VALUE", // required
};
const command = new DescribeReplayCommand(input);
const response = await client.send(command);
// { // DescribeReplayResponse
// ReplayName: "STRING_VALUE",
// ReplayArn: "STRING_VALUE",
// Description: "STRING_VALUE",
// State: "STARTING" || "RUNNING" || "CANCELLING" || "COMPLETED" || "CANCELLED" || "FAILED",
// StateReason: "STRING_VALUE",
// EventSourceArn: "STRING_VALUE",
// Destination: { // ReplayDestination
// Arn: "STRING_VALUE", // required
// FilterArns: [ // ReplayDestinationFilters
// "STRING_VALUE",
// ],
// },
// EventStartTime: new Date("TIMESTAMP"),
// EventEndTime: new Date("TIMESTAMP"),
// EventLastReplayedTime: new Date("TIMESTAMP"),
// ReplayStartTime: new Date("TIMESTAMP"),
// ReplayEndTime: new Date("TIMESTAMP"),
// };
DescribeReplayCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ReplayName Required | string | undefined | The name of the replay to retrieve. |
DescribeReplayCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Description | string | undefined | The description of the replay. |
Destination | ReplayDestination | undefined | A |
EventEndTime | Date | undefined | The time stamp for the last event that was replayed from the archive. |
EventLastReplayedTime | Date | undefined | The time that the event was last replayed. |
EventSourceArn | string | undefined | The ARN of the archive events were replayed from. |
EventStartTime | Date | undefined | The time stamp of the first event that was last replayed from the archive. |
ReplayArn | string | undefined | The ARN of the replay. |
ReplayEndTime | Date | undefined | A time stamp for the time that the replay stopped. |
ReplayName | string | undefined | The name of the replay. |
ReplayStartTime | Date | undefined | A time stamp for the time that the replay started. |
State | ReplayState | undefined | The current state of the replay. |
StateReason | string | undefined | The reason that the replay is in the current state. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InternalException | server | This exception occurs due to unexpected causes. |
ResourceNotFoundException | client | An entity that you specified does not exist. |
EventBridgeServiceException | Base exception class for all service exceptions from EventBridge service. |