describePatchGroups method

Future<DescribePatchGroupsResult> describePatchGroups({ List<PatchOrchestratorFilter>? filters, int? maxResults, String? nextToken, })

Lists all patch groups that have been registered with patch baselines.

May throw InternalServerError.

Parameter filters : Each element in the array is a structure containing a key-value pair.

Supported keys for DescribePatchGroups include the following:

• NAME_PREFIX

  Sample values: AWS- | My-.

• OPERATING_SYSTEM

  Sample values: AMAZON_LINUX | SUSE | WINDOWS

Parameter maxResults : The maximum number of patch groups to return (per page).

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

Implementation

Future<DescribePatchGroupsResult> describePatchGroups({
  List<PatchOrchestratorFilter>? filters,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonSSM.DescribePatchGroups'
  };
  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,
    },
  );

  return DescribePatchGroupsResult.fromJson(jsonResponse.body);
}