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.
Parameters:
-
replay_name
(ReplayName)
–
The name of the replay to retrieve.
Raises:
Source code in docs_src/capo_cloudwatch_events/_services/cloud_watch_events.py
| def describe_replay(
self,
replay_name: "capo_cloudwatch_events.types.replay_name.ReplayName",
*,
config_overrides: Optional[CloudWatchEventsClientConfig] = None,
) -> "capo_cloudwatch_events.types.describe_replay_response.DescribeReplayResponse":
"""<p>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.</p>
Args:
replay_name: <p>The name of the replay to retrieve.</p>
Raises:
capo_cloudwatch_events.errors.internal_exception.InternalException: <p>This exception occurs due to unexpected causes.</p>
capo_cloudwatch_events.errors.resource_not_found_exception.ResourceNotFoundException: <p>An entity that you specified does not exist.</p>
capo_cloudwatch_events.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_cloudwatch_events.types.describe_replay_request.DescribeReplayRequest]",
) -> OperationResponse[
"capo_cloudwatch_events.types.describe_replay_response.DescribeReplayResponse"
]:
import capo_cloudwatch_events._operations.aws_events.describe_replay
output, http_response = (
capo_cloudwatch_events._operations.aws_events.describe_replay.describe_replay(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeReplay")
)
input_: capo_cloudwatch_events.types.describe_replay_request.DescribeReplayRequest = {
"replay_name": replay_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|