describeCacheParameters method

Future<CacheParameterGroupDetails> describeCacheParameters({ required String cacheParameterGroupName, String? marker, int? maxRecords, String? source, })

Returns the detailed parameter list for a particular cache parameter group.

May throw CacheParameterGroupNotFoundFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter cacheParameterGroupName : The name of a specific cache parameter group to return details for.

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.

Parameter source : The parameter types to return.

Valid values: user | system | engine-default

Implementation

Future<CacheParameterGroupDetails> describeCacheParameters({
  required String cacheParameterGroupName,
  String? marker,
  int? maxRecords,
  String? source,
}) async {
  ArgumentError.checkNotNull(
      cacheParameterGroupName, 'cacheParameterGroupName');
  final $request = <String, dynamic>{};
  $request['CacheParameterGroupName'] = cacheParameterGroupName;
  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: 'DescribeCacheParameters',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeCacheParametersMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeCacheParametersResult',
  );
  return CacheParameterGroupDetails.fromXml($result);
}