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

*************************************
get_compliance_summary_by_config_rule
*************************************



.. py:method:: ConfigService.Client.get_compliance_summary_by_config_rule()

  

  Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

  

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


  **Request Syntax**

  ::

    response = client.get_compliance_summary_by_config_rule()
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ComplianceSummary': {
              'CompliantResourceCount': {
                  'CappedCount': 123,
                  'CapExceeded': True|False
              },
              'NonCompliantResourceCount': {
                  'CappedCount': 123,
                  'CapExceeded': True|False
              },
              'ComplianceSummaryTimestamp': datetime(2015, 1, 1)
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ComplianceSummary** *(dict) --* 

        The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

        
        

        - **CompliantResourceCount** *(dict) --* 

          The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

          
          

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

            
      
        

        - **NonCompliantResourceCount** *(dict) --* 

          The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

          
          

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

            
      
        

        - **ComplianceSummaryTimestamp** *(datetime) --* 

          The time that Config created the compliance summary.

          
    
  