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

************************************
describe_conformance_pack_compliance
************************************



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

  

  Returns compliance details for each rule in that conformance pack.

   

  .. note::

    

    You must provide exact rule names.

    

  

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


  **Request Syntax**
  ::

    response = client.describe_conformance_pack_compliance(
        ConformancePackName='string',
        Filters={
            'ConfigRuleNames': [
                'string',
            ],
            'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
        },
        Limit=123,
        NextToken='string'
    )
    
  :type ConformancePackName: string
  :param ConformancePackName: **[REQUIRED]** 

    Name of the conformance pack.

    

  
  :type Filters: dict
  :param Filters: 

    A ``ConformancePackComplianceFilters`` object.

    

  
    - **ConfigRuleNames** *(list) --* 

      Filters the results by Config rule names.

      

    
      - *(string) --* 

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

      Filters the results by compliance.

       

      The allowed values are ``COMPLIANT`` and ``NON_COMPLIANT``. ``INSUFFICIENT_DATA`` is not supported.

      

    
  
  :type Limit: integer
  :param Limit: 

    The maximum number of Config rules within a conformance pack are returned on each page.

    

  
  :type NextToken: string
  :param NextToken: 

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

    

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

    
    ::

      {
          'ConformancePackName': 'string',
          'ConformancePackRuleComplianceList': [
              {
                  'ConfigRuleName': 'string',
                  'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
                  'Controls': [
                      'string',
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        Name of the conformance pack.

        
      

      - **ConformancePackRuleComplianceList** *(list) --* 

        Returns a list of ``ConformancePackRuleCompliance`` objects.

        
        

        - *(dict) --* 

          Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.

          
          

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

            Name of the Config rule.

            
          

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

            Compliance of the Config rule.

            
          

          - **Controls** *(list) --* 

            Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

            
            

            - *(string) --* 
        
      
    
      

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

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

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

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

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

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

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

  