:doc:`ConfigService <../../config>` / Paginator / GetComplianceDetailsByResource

******************************
GetComplianceDetailsByResource
******************************



.. py:class:: ConfigService.Paginator.GetComplianceDetailsByResource

  ::

    
    paginator = client.get_paginator('get_compliance_details_by_resource')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ConfigService.Client.get_compliance_details_by_resource`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ResourceType='string',
          ResourceId='string',
          ComplianceTypes=[
              'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
          ],
          ResourceEvaluationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ResourceType: string
    :param ResourceType: 

      The type of the Amazon Web Services resource for which you want compliance information.

      

    
    :type ResourceId: string
    :param ResourceId: 

      The ID of the Amazon Web Services resource for which you want compliance information.

      

    
    :type ComplianceTypes: list
    :param ComplianceTypes: 

      Filters the results by compliance.

       

      ``INSUFFICIENT_DATA`` is a valid ``ComplianceType`` that is returned when an Config rule cannot be evaluated. However, ``INSUFFICIENT_DATA`` cannot be used as a ``ComplianceType`` for filtering results.

      

    
      - *(string) --* 

      
  
    :type ResourceEvaluationId: string
    :param ResourceEvaluationId: 

      The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

       

      .. note::

        

        You need to only provide either a ``ResourceEvaluationID`` or a ``ResourceID ``and ``ResourceType``.

        

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'EvaluationResults': [
                {
                    'EvaluationResultIdentifier': {
                        'EvaluationResultQualifier': {
                            'ConfigRuleName': 'string',
                            'ResourceType': 'string',
                            'ResourceId': 'string',
                            'EvaluationMode': 'DETECTIVE'|'PROACTIVE'
                        },
                        'OrderingTimestamp': datetime(2015, 1, 1),
                        'ResourceEvaluationId': 'string'
                    },
                    'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
                    'ResultRecordedTime': datetime(2015, 1, 1),
                    'ConfigRuleInvokedTime': datetime(2015, 1, 1),
                    'Annotation': 'string',
                    'ResultToken': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **EvaluationResults** *(list) --* 

          Indicates whether the specified Amazon Web Services resource complies each Config rule.

          
          

          - *(dict) --* 

            The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.

            
            

            - **EvaluationResultIdentifier** *(dict) --* 

              Uniquely identifies the evaluation result.

              
              

              - **EvaluationResultQualifier** *(dict) --* 

                Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

                
                

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

                  The name of the Config rule that was used in the evaluation.

                  
                

                - **ResourceType** *(string) --* 

                  The type of Amazon Web Services resource that was evaluated.

                  
                

                - **ResourceId** *(string) --* 

                  The ID of the evaluated Amazon Web Services resource.

                  
                

                - **EvaluationMode** *(string) --* 

                  The mode of an evaluation. The valid values are Detective or Proactive.

                  
            
              

              - **OrderingTimestamp** *(datetime) --* 

                The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.

                
              

              - **ResourceEvaluationId** *(string) --* 

                A Unique ID for an evaluation result.

                
          
            

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

              Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

               

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

              
            

            - **ResultRecordedTime** *(datetime) --* 

              The time when Config recorded the evaluation result.

              
            

            - **ConfigRuleInvokedTime** *(datetime) --* 

              The time when the Config rule evaluated the Amazon Web Services resource.

              
            

            - **Annotation** *(string) --* 

              Supplementary information about how the evaluation determined the compliance.

              
            

            - **ResultToken** *(string) --* 

              An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

              
        
      
    