describeDBParameters method

Future<DBParameterGroupDetails> describeDBParameters({ required String dBParameterGroupName, List<Filter>? filters, String? marker, int? maxRecords, String? source, })

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

May throw DBParameterGroupNotFoundFault.

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

Constraints:

• If supplied, must match the name of an existing DBParameterGroup.

Parameter filters : This parameter is not currently supported.

Parameter marker : An optional pagination token provided by a previous DescribeDBParameters 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 the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Parameter source : The parameter types to return.

Default: All parameter types returned

Valid Values: user | system | engine-default

Implementation

Future<DBParameterGroupDetails> describeDBParameters({
  required String dBParameterGroupName,
  List<Filter>? filters,
  String? marker,
  int? maxRecords,
  String? source,
}) async {
  ArgumentError.checkNotNull(dBParameterGroupName, 'dBParameterGroupName');
  final $request = <String, dynamic>{};
  $request['DBParameterGroupName'] = dBParameterGroupName;
  filters?.also((arg) => $request['Filters'] = arg);
  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: 'DescribeDBParameters',
    version: '2014-10-31',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeDBParametersMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeDBParametersResult',
  );
  return DBParameterGroupDetails.fromXml($result);
}