describeDBClusterParameterGroups method

Future<DBClusterParameterGroupsMessage> describeDBClusterParameterGroups({ String? dBClusterParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, })

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.

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

May throw DBParameterGroupNotFoundFault.

Parameter dBClusterParameterGroupName : The name of a specific DB cluster parameter group to return details for.

Constraints:

• If supplied, must match the name of an existing DBClusterParameterGroup.

Parameter filters : This parameter isn't currently supported.

Parameter marker : An optional pagination token provided by a previous DescribeDBClusterParameterGroups 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Implementation

Future<DBClusterParameterGroupsMessage> describeDBClusterParameterGroups({
  String? dBClusterParameterGroupName,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  dBClusterParameterGroupName
      ?.also((arg) => $request['DBClusterParameterGroupName'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDBClusterParameterGroups',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDBClusterParameterGroupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDBClusterParameterGroupsResult',
  );
  return DBClusterParameterGroupsMessage.fromXml($result);
}