describeCacheEngineVersions method

Future<CacheEngineVersionMessage> describeCacheEngineVersions({ String? cacheParameterGroupFamily, bool? defaultOnly, String? engine, String? engineVersion, String? marker, int? maxRecords, })

Returns a list of the available cache engines and their versions.

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

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

Constraints:

• Must be 1 to 255 alphanumeric characters
• First character must be a letter
• Cannot end with a hyphen or contain two consecutive hyphens

Parameter defaultOnly : If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Parameter engine : The cache engine to return. Valid values: memcached | redis

Parameter engineVersion : The cache engine version to return.

Example: 1.4.14

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<CacheEngineVersionMessage> describeCacheEngineVersions({
  String? cacheParameterGroupFamily,
  bool? defaultOnly,
  String? engine,
  String? engineVersion,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  cacheParameterGroupFamily
      ?.also((arg) => $request['CacheParameterGroupFamily'] = arg);
  defaultOnly?.also((arg) => $request['DefaultOnly'] = arg);
  engine?.also((arg) => $request['Engine'] = arg);
  engineVersion?.also((arg) => $request['EngineVersion'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeCacheEngineVersions',
    version: '2015-02-02',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeCacheEngineVersionsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeCacheEngineVersionsResult',
  );
  return CacheEngineVersionMessage.fromXml($result);
}