describeOptionGroups method

Future<OptionGroups> describeOptionGroups({ String? engineName, List<Filter>? filters, String? majorEngineVersion, String? marker, int? maxRecords, String? optionGroupName, })

Describes the available option groups.

May throw OptionGroupNotFoundFault.

Parameter engineName : Filters the list of option groups to only include groups associated with a specific database engine.

Parameter filters : This parameter isn't currently supported.

Parameter majorEngineVersion : Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Parameter marker : An optional pagination token provided by a previous DescribeOptionGroups 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 records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameter optionGroupName : The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Implementation

Future<OptionGroups> describeOptionGroups({
  String? engineName,
  List<Filter>? filters,
  String? majorEngineVersion,
  String? marker,
  int? maxRecords,
  String? optionGroupName,
}) async {
  final $request = <String, dynamic>{};
  engineName?.also((arg) => $request['EngineName'] = arg);
  filters?.also((arg) => $request['Filters'] = arg);
  majorEngineVersion?.also((arg) => $request['MajorEngineVersion'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  optionGroupName?.also((arg) => $request['OptionGroupName'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeOptionGroups',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeOptionGroupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeOptionGroupsResult',
  );
  return OptionGroups.fromXml($result);
}