describeReplay method

Future<DescribeReplayResponse> describeReplay({ required String replayName, })

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.

May throw ResourceNotFoundException. May throw InternalException.

Parameter replayName : The name of the replay to retrieve.

Implementation

Future<DescribeReplayResponse> describeReplay({
  required String replayName,
}) async {
  ArgumentError.checkNotNull(replayName, 'replayName');
  _s.validateStringLength(
    'replayName',
    replayName,
    1,
    64,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSEvents.DescribeReplay'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ReplayName': replayName,
    },
  );

  return DescribeReplayResponse.fromJson(jsonResponse.body);
}