describeParameters method

Future<DescribeParametersResponse> describeParameters({ required String parameterGroupName, int? maxResults, String? nextToken, String? source, })

Returns the detailed parameter list for a particular parameter group.

May throw ParameterGroupNotFoundFault. May throw ServiceLinkedRoleNotFoundFault. May throw InvalidParameterValueException. May throw InvalidParameterCombinationException.

Parameter parameterGroupName : The name of the parameter group.

Parameter maxResults : The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Parameter nextToken : An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

Parameter source : How the parameter is defined. For example, system denotes a system-defined parameter.

Implementation

Future<DescribeParametersResponse> describeParameters({
  required String parameterGroupName,
  int? maxResults,
  String? nextToken,
  String? source,
}) async {
  ArgumentError.checkNotNull(parameterGroupName, 'parameterGroupName');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDAXV3.DescribeParameters'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ParameterGroupName': parameterGroupName,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (source != null) 'Source': source,
    },
  );

  return DescribeParametersResponse.fromJson(jsonResponse.body);
}