describeDBClusterParameters method

Future<DBClusterParameterGroupDetails> describeDBClusterParameters({ required String dBClusterParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, String? source, })

Returns the detailed parameter list for a particular 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 parameter 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 DescribeDBClusterParameters 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.

Parameter source : A value that indicates to return only parameters for a specific source. Parameter sources can be engine, service, or customer.

Implementation

Future<DBClusterParameterGroupDetails> describeDBClusterParameters({
  required String dBClusterParameterGroupName,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
  String? source,
}) async {
  ArgumentError.checkNotNull(
      dBClusterParameterGroupName, 'dBClusterParameterGroupName');
  final $request = <String, dynamic>{};
  $request['DBClusterParameterGroupName'] = dBClusterParameterGroupName;
  filters?.also((arg) => $request['Filters'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  source?.also((arg) => $request['Source'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDBClusterParameters',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDBClusterParametersMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDBClusterParametersResult',
  );
  return DBClusterParameterGroupDetails.fromXml($result);
}