describeDefaultClusterParameters method

Future<DescribeDefaultClusterParametersResult> describeDefaultClusterParameters({ required String parameterGroupFamily, String? marker, int? maxRecords, })

Returns a list of parameter settings for the specified parameter group family.

For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Parameter parameterGroupFamily : The name of the cluster parameter group family.

Parameter marker : An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeDefaultClusterParameters request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Parameter maxRecords : The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Implementation

Future<DescribeDefaultClusterParametersResult>
    describeDefaultClusterParameters({
  required String parameterGroupFamily,
  String? marker,
  int? maxRecords,
}) async {
  ArgumentError.checkNotNull(parameterGroupFamily, 'parameterGroupFamily');
  _s.validateStringLength(
    'parameterGroupFamily',
    parameterGroupFamily,
    0,
    2147483647,
    isRequired: true,
  );
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  $request['ParameterGroupFamily'] = parameterGroupFamily;
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDefaultClusterParameters',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDefaultClusterParametersMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDefaultClusterParametersResult',
  );
  return DescribeDefaultClusterParametersResult.fromXml($result);
}