:doc:`SSM <../../ssm>` / Paginator / DescribePatchGroups

*******************
DescribePatchGroups
*******************



.. py:class:: SSM.Paginator.DescribePatchGroups

  ::

    
    paginator = client.get_paginator('describe_patch_groups')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SSM.Client.describe_patch_groups`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ssm-2014-11-06/DescribePatchGroups>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Key': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param 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``
      

      

    
      - *(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) --* 

          
      
      
  
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'Mappings': [
                {
                    'PatchGroup': 'string',
                    'BaselineIdentity': {
                        'BaselineId': 'string',
                        'BaselineName': 'string',
                        'OperatingSystem': 'WINDOWS'|'AMAZON_LINUX'|'AMAZON_LINUX_2'|'AMAZON_LINUX_2022'|'UBUNTU'|'REDHAT_ENTERPRISE_LINUX'|'SUSE'|'CENTOS'|'ORACLE_LINUX'|'DEBIAN'|'MACOS'|'RASPBIAN'|'ROCKY_LINUX'|'ALMA_LINUX'|'AMAZON_LINUX_2023',
                        '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) --* 

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

                
          
        
      
    