describeGlobalReplicationGroups method

Future<DescribeGlobalReplicationGroupsResult> describeGlobalReplicationGroups({ String? globalReplicationGroupId, String? marker, int? maxRecords, bool? showMemberInfo, })

Returns information about a particular global replication group. If no identifier is specified, returns information about all Global Datastores.

May throw GlobalReplicationGroupNotFoundFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter globalReplicationGroupId : The name of the Global Datastore

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.

Parameter showMemberInfo : Returns the list of members that comprise the Global Datastore.

Implementation

Future<DescribeGlobalReplicationGroupsResult>
    describeGlobalReplicationGroups({
  String? globalReplicationGroupId,
  String? marker,
  int? maxRecords,
  bool? showMemberInfo,
}) async {
  final $request = <String, dynamic>{};
  globalReplicationGroupId
      ?.also((arg) => $request['GlobalReplicationGroupId'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  showMemberInfo?.also((arg) => $request['ShowMemberInfo'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeGlobalReplicationGroups',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeGlobalReplicationGroupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeGlobalReplicationGroupsResult',
  );
  return DescribeGlobalReplicationGroupsResult.fromXml($result);
}