:doc:`ConfigService <../../config>` / Paginator / DescribeAggregateComplianceByConformancePacks

*********************************************
DescribeAggregateComplianceByConformancePacks
*********************************************



.. py:class:: ConfigService.Paginator.DescribeAggregateComplianceByConformancePacks

  ::

    
    paginator = client.get_paginator('describe_aggregate_compliance_by_conformance_packs')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ConfigService.Client.describe_aggregate_compliance_by_conformance_packs`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DescribeAggregateComplianceByConformancePacks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ConfigurationAggregatorName='string',
          Filters={
              'ConformancePackName': 'string',
              'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
              'AccountId': 'string',
              'AwsRegion': 'string'
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ConfigurationAggregatorName: string
    :param ConfigurationAggregatorName: **[REQUIRED]** 

      The name of the configuration aggregator.

      

    
    :type Filters: dict
    :param Filters: 

      Filters the result by ``AggregateConformancePackComplianceFilters`` object.

      

    
      - **ConformancePackName** *(string) --* 

        The name of the conformance pack.

        

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

        The compliance status of the conformance pack.

        

      
      - **AccountId** *(string) --* 

        The 12-digit Amazon Web Services account ID of the source account.

        

      
      - **AwsRegion** *(string) --* 

        The source Amazon Web Services Region from where the data is aggregated.

        

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

      
      ::

        {
            'AggregateComplianceByConformancePacks': [
                {
                    'ConformancePackName': 'string',
                    'Compliance': {
                        'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
                        'CompliantRuleCount': 123,
                        'NonCompliantRuleCount': 123,
                        'TotalRuleCount': 123
                    },
                    'AccountId': 'string',
                    'AwsRegion': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **AggregateComplianceByConformancePacks** *(list) --* 

          Returns the ``AggregateComplianceByConformancePack`` object.

          
          

          - *(dict) --* 

            Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.

             

            A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.

            
            

            - **ConformancePackName** *(string) --* 

              The name of the conformance pack.

              
            

            - **Compliance** *(dict) --* 

              The compliance status of the conformance pack.

              
              

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

                The compliance status of the conformance pack.

                
              

              - **CompliantRuleCount** *(integer) --* 

                The number of compliant Config Rules.

                
              

              - **NonCompliantRuleCount** *(integer) --* 

                The number of noncompliant Config Rules.

                
              

              - **TotalRuleCount** *(integer) --* 

                Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

                
          
            

            - **AccountId** *(string) --* 

              The 12-digit Amazon Web Services account ID of the source account.

              
            

            - **AwsRegion** *(string) --* 

              The source Amazon Web Services Region from where the data is aggregated.

              
        
      
    