listReplays method

Future<ListReplaysResponse> listReplays({ String? eventSourceArn, int? limit, String? namePrefix, String? nextToken, ReplayState? state, })

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.

May throw InternalException.

Parameter eventSourceArn : The ARN of the archive from which the events are replayed.

Parameter limit : The maximum number of replays to retrieve.

Parameter namePrefix : A name prefix to filter the replays returned. Only replays with name that match the prefix are returned.

Parameter nextToken : The token returned by a previous call, which you can use to retrieve the next set of results.

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.

Parameter state : The state of the replay.

Implementation

Future<ListReplaysResponse> listReplays({
  String? eventSourceArn,
  int? limit,
  String? namePrefix,
  String? nextToken,
  ReplayState? state,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSEvents.ListReplays'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (eventSourceArn != null) 'EventSourceArn': eventSourceArn,
      if (limit != null) 'Limit': limit,
      if (namePrefix != null) 'NamePrefix': namePrefix,
      if (nextToken != null) 'NextToken': nextToken,
      if (state != null) 'State': state.value,
    },
  );

  return ListReplaysResponse.fromJson(jsonResponse.body);
}