SSM / Paginator / DescribePatchGroups


class SSM.Paginator.DescribePatchGroups#
paginator = client.get_paginator('describe_patch_groups')

Creates an iterator that will paginate through responses from SSM.Client.describe_patch_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Key': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • Filters (list) –

    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-.


    • (dict) –

      Defines a filter used in Patch Manager APIs. Supported filter keys depend on the API operation that includes the filter. Patch Manager API operations that use PatchOrchestratorFilter include the following:

      • DescribeAvailablePatches

      • DescribeInstancePatches

      • DescribePatchBaselines

      • DescribePatchGroups

      • Key (string) –

        The key for the filter.

      • Values (list) –

        The value for the filter.

        • (string) –

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



Response Syntax

    'Mappings': [
            'PatchGroup': 'string',
            'BaselineIdentity': {
                'BaselineId': 'string',
                'BaselineName': 'string',
                'BaselineDescription': 'string',
                'DefaultBaseline': True|False


Response Structure

  • (dict) –

    • Mappings (list) –

      Each entry in the array contains:

      • PatchGroup: string (between 1 and 256 characters. Regex: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$)

      • PatchBaselineIdentity: A PatchBaselineIdentity element.

      • (dict) –

        The mapping between a patch group and the patch baseline the patch group is registered with.

        • PatchGroup (string) –

          The name of the patch group registered with the patch baseline.

        • BaselineIdentity (dict) –

          The patch baseline the patch group is registered with.

          • BaselineId (string) –

            The ID of the patch baseline.

          • BaselineName (string) –

            The name of the patch baseline.

          • OperatingSystem (string) –

            Defines the operating system the patch baseline applies to. The default value is WINDOWS.

          • BaselineDescription (string) –

            The description of the patch baseline.

          • DefaultBaseline (boolean) –

            Whether this is the default baseline. Amazon Web Services Systems Manager supports creating multiple default patch baselines. For example, you can create a default patch baseline for each operating system.