describeGlobalClusters method

Future<GlobalClustersMessage> describeGlobalClusters({
  1. List<Filter>? filters,
  2. String? globalClusterIdentifier,
  3. String? marker,
  4. int? maxRecords,
})

Returns information about Aurora global database clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.

May throw GlobalClusterNotFoundFault.

Parameter filters : A filter that specifies one or more global DB clusters to describe.

Supported filters:

  • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs.

Parameter globalClusterIdentifier : The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DBClusterIdentifier.

Parameter marker : An optional pagination token provided by a previous DescribeGlobalClusters request. 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 pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Implementation

Future<GlobalClustersMessage> describeGlobalClusters({
  List<Filter>? filters,
  String? globalClusterIdentifier,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  filters?.also((arg) => $request['Filters'] = arg);
  globalClusterIdentifier
      ?.also((arg) => $request['GlobalClusterIdentifier'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeGlobalClusters',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeGlobalClustersMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeGlobalClustersResult',
  );
  return GlobalClustersMessage.fromXml($result);
}