describeParameters method

Future<DescribeParametersResult> describeParameters({ List<ParametersFilter>? filters, int? maxResults, String? nextToken, List<ParameterStringFilter>? parameterFilters, })

Get information about a parameter.

May throw InternalServerError. May throw InvalidFilterKey. May throw InvalidFilterOption. May throw InvalidFilterValue. May throw InvalidNextToken.

Parameter filters : This data type is deprecated. Instead, use ParameterFilters.

Parameter maxResults : The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Parameter nextToken : The token for the next set of items to return. (You received this token from a previous call.)

Parameter parameterFilters : Filters to limit the request results.

Implementation

Future<DescribeParametersResult> describeParameters({
  List<ParametersFilter>? filters,
  int? maxResults,
  String? nextToken,
  List<ParameterStringFilter>? parameterFilters,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    50,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.DescribeParameters'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filters != null) 'Filters': filters,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (parameterFilters != null) 'ParameterFilters': parameterFilters,
    },
  );

  return DescribeParametersResult.fromJson(jsonResponse.body);
}