describeReplicationGroups method

Future<ReplicationGroupMessage> describeReplicationGroups({ String? marker, int? maxRecords, String? replicationGroupId, })

Returns information about a particular replication group. If no identifier is specified, DescribeReplicationGroups returns information about all replication groups.

May throw ReplicationGroupNotFoundFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter marker : An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Parameter maxRecords : The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Parameter replicationGroupId : The identifier for the replication group to be described. This parameter is not case sensitive.

If you do not specify this parameter, information about all replication groups is returned.

Implementation

Future<ReplicationGroupMessage> describeReplicationGroups({
  String? marker,
  int? maxRecords,
  String? replicationGroupId,
}) async {
  final $request = <String, dynamic>{};
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  replicationGroupId?.also((arg) => $request['ReplicationGroupId'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeReplicationGroups',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeReplicationGroupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeReplicationGroupsResult',
  );
  return ReplicationGroupMessage.fromXml($result);
}