describeDBEngineVersions method

Future<DBEngineVersionMessage> describeDBEngineVersions({ String? dBParameterGroupFamily, bool? defaultOnly, String? engine, String? engineVersion, List<Filter>? filters, bool? includeAll, bool? listSupportedCharacterSets, bool? listSupportedTimezones, String? marker, int? maxRecords, })

Returns a list of the available DB engines.

Parameter dBParameterGroupFamily : The name of a specific DB parameter group family to return details for.

Constraints:

• If supplied, must match an existing DBParameterGroupFamily.

Parameter defaultOnly : A value that indicates whether only the default version of the specified engine or engine and major version combination is returned.

Parameter engine : The database engine to return.

Parameter engineVersion : The database engine version to return.

Example: 5.1.49

Parameter filters : This parameter isn't currently supported.

Parameter includeAll : A value that indicates whether to include engine versions that aren't available in the list. The default is to list only available engine versions.

Parameter listSupportedCharacterSets : A value that indicates whether to list the supported character sets for each engine version.

If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

Parameter listSupportedTimezones : A value that indicates whether to list the supported time zones for each engine version.

If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

Parameter marker : An optional pagination token provided by a previous 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 than the MaxRecords value is available, 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.

Implementation

Future<DBEngineVersionMessage> describeDBEngineVersions({
  String? dBParameterGroupFamily,
  bool? defaultOnly,
  String? engine,
  String? engineVersion,
  List<Filter>? filters,
  bool? includeAll,
  bool? listSupportedCharacterSets,
  bool? listSupportedTimezones,
  String? marker,
  int? maxRecords,
}) async {
  final $request = <String, dynamic>{};
  dBParameterGroupFamily
      ?.also((arg) => $request['DBParameterGroupFamily'] = arg);
  defaultOnly?.also((arg) => $request['DefaultOnly'] = arg);
  engine?.also((arg) => $request['Engine'] = arg);
  engineVersion?.also((arg) => $request['EngineVersion'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  includeAll?.also((arg) => $request['IncludeAll'] = arg);
  listSupportedCharacterSets
      ?.also((arg) => $request['ListSupportedCharacterSets'] = arg);
  listSupportedTimezones
      ?.also((arg) => $request['ListSupportedTimezones'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeDBEngineVersions',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDBEngineVersionsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDBEngineVersionsResult',
  );
  return DBEngineVersionMessage.fromXml($result);
}