:doc:`ConfigService <../../config>` / Client / describe_aggregate_compliance_by_config_rules

*********************************************
describe_aggregate_compliance_by_config_rules
*********************************************



.. py:method:: ConfigService.Client.describe_aggregate_compliance_by_config_rules(**kwargs)

  

  Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.

   

  .. note::

    

    The results can return an empty result page, but if you have a ``nextToken``, the results are displayed on the next page.

    

  

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


  **Request Syntax**
  ::

    response = client.describe_aggregate_compliance_by_config_rules(
        ConfigurationAggregatorName='string',
        Filters={
            'ConfigRuleName': 'string',
            'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
            'AccountId': 'string',
            'AwsRegion': 'string'
        },
        Limit=123,
        NextToken='string'
    )
    
  :type ConfigurationAggregatorName: string
  :param ConfigurationAggregatorName: **[REQUIRED]** 

    The name of the configuration aggregator.

    

  
  :type Filters: dict
  :param Filters: 

    Filters the results by ConfigRuleComplianceFilters object.

    

  
    - **ConfigRuleName** *(string) --* 

      The name of the Config rule.

      

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

      The rule compliance status.

       

      For the ``ConfigRuleComplianceFilters`` data type, Config supports only ``COMPLIANT`` and ``NON_COMPLIANT``. Config does not support the ``NOT_APPLICABLE`` and the ``INSUFFICIENT_DATA`` values.

      

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

      The 12-digit account ID of the source account.

      

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

      The source region where the data is aggregated.

      

    
  
  :type Limit: integer
  :param Limit: 

    The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

    

  
  :type NextToken: string
  :param NextToken: 

    The ``nextToken`` string returned on a previous page that you use to get the next page of results in a paginated response.

    

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

    
    ::

      {
          'AggregateComplianceByConfigRules': [
              {
                  'ConfigRuleName': 'string',
                  'Compliance': {
                      'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
                      'ComplianceContributorCount': {
                          'CappedCount': 123,
                          'CapExceeded': True|False
                      }
                  },
                  'AccountId': 'string',
                  'AwsRegion': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AggregateComplianceByConfigRules** *(list) --* 

        Returns a list of AggregateComplianceByConfigRule object.

        
        

        - *(dict) --* 

          Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.

           

          A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.

          
          

          - **ConfigRuleName** *(string) --* 

            The name of the Config rule.

            
          

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

            Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

            
            

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

              Indicates whether an Amazon Web Services resource or Config rule is compliant.

               

              A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

               

              A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

               

              Config returns the ``INSUFFICIENT_DATA`` value when no evaluation results are available for the Amazon Web Services resource or Config rule.

               

              For the ``Compliance`` data type, Config supports only ``COMPLIANT``, ``NON_COMPLIANT``, and ``INSUFFICIENT_DATA`` values. Config does not support the ``NOT_APPLICABLE`` value for the ``Compliance`` data type.

              
            

            - **ComplianceContributorCount** *(dict) --* 

              The number of Amazon Web Services resources or Config rules that cause a result of ``NON_COMPLIANT``, up to a maximum number.

              
              

              - **CappedCount** *(integer) --* 

                The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

                
              

              - **CapExceeded** *(boolean) --* 

                Indicates whether the maximum count is reached.

                
          
        
          

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

            The 12-digit account ID of the source account.

            
          

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

            The source region from where the data is aggregated.

            
      
    
      

      - **NextToken** *(string) --* 

        The ``nextToken`` string returned on a previous page that you use to get the next page of results in a paginated response.

        
  
  **Exceptions**
  
  *   :py:class:`ConfigService.Client.exceptions.ValidationException`

  
  *   :py:class:`ConfigService.Client.exceptions.InvalidLimitException`

  
  *   :py:class:`ConfigService.Client.exceptions.InvalidNextTokenException`

  
  *   :py:class:`ConfigService.Client.exceptions.NoSuchConfigurationAggregatorException`

  