describeEngineDefaultParameters method

Future<DescribeEngineDefaultParametersResult> describeEngineDefaultParameters({
  1. required String cacheParameterGroupFamily,
  2. String? marker,
  3. int? maxRecords,
})

Returns the default engine and system parameter information for the specified cache engine.

May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter cacheParameterGroupFamily : The name of the cache parameter group family.

Valid values are: memcached1.4 | memcached1.5 | memcached1.6 | redis2.6 | redis2.8 | redis3.2 | redis4.0 | redis5.0 | redis6.x |

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.

Default: 100

Constraints: minimum 20; maximum 100.

Implementation

Future<DescribeEngineDefaultParametersResult>
    describeEngineDefaultParameters({
  required String cacheParameterGroupFamily,
  String? marker,
  int? maxRecords,
}) async {
  ArgumentError.checkNotNull(
      cacheParameterGroupFamily, 'cacheParameterGroupFamily');
  final $request = <String, dynamic>{};
  $request['CacheParameterGroupFamily'] = cacheParameterGroupFamily;
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeEngineDefaultParameters',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeEngineDefaultParametersMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeEngineDefaultParametersResult',
  );
  return DescribeEngineDefaultParametersResult.fromXml($result);
}