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

********************************************
get_aggregate_config_rule_compliance_summary
********************************************



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

  

  Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

   

  .. 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/GetAggregateConfigRuleComplianceSummary>`_  


  **Request Syntax**
  ::

    response = client.get_aggregate_config_rule_compliance_summary(
        ConfigurationAggregatorName='string',
        Filters={
            'AccountId': 'string',
            'AwsRegion': 'string'
        },
        GroupByKey='ACCOUNT_ID'|'AWS_REGION',
        Limit=123,
        NextToken='string'
    )
    
  :type ConfigurationAggregatorName: string
  :param ConfigurationAggregatorName: **[REQUIRED]** 

    The name of the configuration aggregator.

    

  
  :type Filters: dict
  :param Filters: 

    Filters the results based on the ConfigRuleComplianceSummaryFilters object.

    

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

      The 12-digit account ID of the source account.

      

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

      The source region where the data is aggregated.

      

    
  
  :type GroupByKey: string
  :param GroupByKey: 

    Groups the result based on ACCOUNT_ID or AWS_REGION.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of evaluation results returned on each page. The default is 1000. You cannot specify a number greater than 1000. 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**

    
    ::

      {
          'GroupByKey': 'string',
          'AggregateComplianceCounts': [
              {
                  'GroupName': 'string',
                  'ComplianceSummary': {
                      'CompliantResourceCount': {
                          'CappedCount': 123,
                          'CapExceeded': True|False
                      },
                      'NonCompliantResourceCount': {
                          'CappedCount': 123,
                          'CapExceeded': True|False
                      },
                      'ComplianceSummaryTimestamp': datetime(2015, 1, 1)
                  }
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **GroupByKey** *(string) --* 

        Groups the result based on ACCOUNT_ID or AWS_REGION.

        
      

      - **AggregateComplianceCounts** *(list) --* 

        Returns a list of AggregateComplianceCounts object.

        
        

        - *(dict) --* 

          Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

          
          

          - **GroupName** *(string) --* 

            The 12-digit account ID or region based on the GroupByKey value.

            
          

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

            The number of compliant and noncompliant Config rules.

            
            

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

              
        
      
    
      

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

  