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

*************************************************
get_aggregate_conformance_pack_compliance_summary
*************************************************



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

  

  Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

   

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


  **Request Syntax**
  ::

    response = client.get_aggregate_conformance_pack_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 ``AggregateConformancePackComplianceSummaryFilters`` object.

    

  
    - **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 GroupByKey: string
  :param GroupByKey: 

    Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of 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**

    
    ::

      {
          'AggregateConformancePackComplianceSummaries': [
              {
                  'ComplianceSummary': {
                      'CompliantConformancePackCount': 123,
                      'NonCompliantConformancePackCount': 123
                  },
                  'GroupName': 'string'
              },
          ],
          'GroupByKey': 'string',
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AggregateConformancePackComplianceSummaries** *(list) --* 

        Returns a list of ``AggregateConformancePackComplianceSummary`` object.

        
        

        - *(dict) --* 

          Provides a summary of compliance based on either account ID or region.

          
          

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

            Returns an ``AggregateConformancePackComplianceCount`` object.

            
            

            - **CompliantConformancePackCount** *(integer) --* 

              Number of compliant conformance packs.

              
            

            - **NonCompliantConformancePackCount** *(integer) --* 

              Number of noncompliant conformance packs.

              
        
          

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

            Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

            
      
    
      

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

        Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

        
      

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

  