describeInstanceProperties method

Future<DescribeInstancePropertiesResult> describeInstanceProperties({ List<InstancePropertyStringFilter>? filtersWithOperator, List<InstancePropertyFilter>? instancePropertyFilterList, int? maxResults, String? nextToken, })

An API operation used by the Systems Manager console to display information about Systems Manager managed nodes.

May throw InternalServerError. May throw InvalidActivationId. May throw InvalidDocument. May throw InvalidFilterKey. May throw InvalidInstanceId. May throw InvalidInstancePropertyFilterValue. May throw InvalidNextToken.

Parameter filtersWithOperator : The request filters to use with the operator.

Parameter instancePropertyFilterList : An array of instance property filters.

Parameter maxResults : The maximum number of items to return for the 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 provided by a previous request to use to return the next set of properties.

Implementation

Future<DescribeInstancePropertiesResult> describeInstanceProperties({
  List<InstancePropertyStringFilter>? filtersWithOperator,
  List<InstancePropertyFilter>? instancePropertyFilterList,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    5,
    1000,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.DescribeInstanceProperties'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (filtersWithOperator != null)
        'FiltersWithOperator': filtersWithOperator,
      if (instancePropertyFilterList != null)
        'InstancePropertyFilterList': instancePropertyFilterList,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeInstancePropertiesResult.fromJson(jsonResponse.body);
}