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

***********************
ListComplianceSummaries
***********************



.. py:class:: SSM.Paginator.ListComplianceSummaries

  ::

    
    paginator = client.get_paginator('list_compliance_summaries')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Key': 'string',
                  'Values': [
                      'string',
                  ],
                  'Type': 'EQUAL'|'NOT_EQUAL'|'BEGIN_WITH'|'LESS_THAN'|'GREATER_THAN'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      One or more compliance or inventory filters. Use a filter to return a more specific list of results.

      

    
      - *(dict) --* 

        One or more filters. Use a filter to return a more specific list of results.

        

      
        - **Key** *(string) --* 

          The name of the filter.

          

        
        - **Values** *(list) --* 

          The value for which to search.

          

        
          - *(string) --* 

          
      
        - **Type** *(string) --* 

          The type of comparison that should be performed for the value: Equal, NotEqual, BeginWith, LessThan, or GreaterThan.

          

        
      
  
    :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**

      
      ::

        {
            'ComplianceSummaryItems': [
                {
                    'ComplianceType': 'string',
                    'CompliantSummary': {
                        'CompliantCount': 123,
                        'SeveritySummary': {
                            'CriticalCount': 123,
                            'HighCount': 123,
                            'MediumCount': 123,
                            'LowCount': 123,
                            'InformationalCount': 123,
                            'UnspecifiedCount': 123
                        }
                    },
                    'NonCompliantSummary': {
                        'NonCompliantCount': 123,
                        'SeveritySummary': {
                            'CriticalCount': 123,
                            'HighCount': 123,
                            'MediumCount': 123,
                            'LowCount': 123,
                            'InformationalCount': 123,
                            'UnspecifiedCount': 123
                        }
                    }
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ComplianceSummaryItems** *(list) --* 

          A list of compliant and non-compliant summary counts based on compliance types. For example, this call returns State Manager associations, patches, or custom compliance types according to the filter criteria that you specified.

          
          

          - *(dict) --* 

            A summary of compliance information by compliance type.

            
            

            - **ComplianceType** *(string) --* 

              The type of compliance item. For example, the compliance type can be Association, Patch, or Custom:string.

              
            

            - **CompliantSummary** *(dict) --* 

              A list of COMPLIANT items for the specified compliance type.

              
              

              - **CompliantCount** *(integer) --* 

                The total number of resources that are compliant.

                
              

              - **SeveritySummary** *(dict) --* 

                A summary of the compliance severity by compliance type.

                
                

                - **CriticalCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of ``Critical``. Critical severity is determined by the organization that published the compliance items.

                  
                

                - **HighCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

                  
                

                - **MediumCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

                  
                

                - **LowCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

                  
                

                - **InformationalCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

                  
                

                - **UnspecifiedCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

                  
            
          
            

            - **NonCompliantSummary** *(dict) --* 

              A list of NON_COMPLIANT items for the specified compliance type.

              
              

              - **NonCompliantCount** *(integer) --* 

                The total number of compliance items that aren't compliant.

                
              

              - **SeveritySummary** *(dict) --* 

                A summary of the non-compliance severity by compliance type

                
                

                - **CriticalCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of ``Critical``. Critical severity is determined by the organization that published the compliance items.

                  
                

                - **HighCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

                  
                

                - **MediumCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

                  
                

                - **LowCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

                  
                

                - **InformationalCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

                  
                

                - **UnspecifiedCount** *(integer) --* 

                  The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

                  
            
          
        
      
    