:doc:`Inspector <../../inspector>` / Paginator / ListFindings

************
ListFindings
************



.. py:class:: Inspector.Paginator.ListFindings

  ::

    
    paginator = client.get_paginator('list_findings')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Inspector.Client.list_findings`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListFindings>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assessmentRunArns=[
              'string',
          ],
          filter={
              'agentIds': [
                  'string',
              ],
              'autoScalingGroups': [
                  'string',
              ],
              'ruleNames': [
                  'string',
              ],
              'severities': [
                  'Low'|'Medium'|'High'|'Informational'|'Undefined',
              ],
              'rulesPackageArns': [
                  'string',
              ],
              'attributes': [
                  {
                      'key': 'string',
                      'value': 'string'
                  },
              ],
              'userAttributes': [
                  {
                      'key': 'string',
                      'value': 'string'
                  },
              ],
              'creationTimeRange': {
                  'beginDate': datetime(2015, 1, 1),
                  'endDate': datetime(2015, 1, 1)
              }
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assessmentRunArns: list
    :param assessmentRunArns: 

      The ARNs of the assessment runs that generate the findings that you want to list.

      

    
      - *(string) --* 

      
  
    :type filter: dict
    :param filter: 

      You can use this parameter to specify a subset of data to be included in the action's response.

       

      For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

      

    
      - **agentIds** *(list) --* 

        For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the **agentId** property of the  Finding data type.

        

      
        - *(string) --* 

        
    
      - **autoScalingGroups** *(list) --* 

        For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the **autoScalingGroup** property of the  Finding data type.

        

      
        - *(string) --* 

        
    
      - **ruleNames** *(list) --* 

        For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the **ruleName** property of the  Finding data type.

        

      
        - *(string) --* 

        
    
      - **severities** *(list) --* 

        For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the **severity** property of the  Finding data type.

        

      
        - *(string) --* 

        
    
      - **rulesPackageArns** *(list) --* 

        For a record to match a filter, one of the values that is specified for this data type property must be the exact match of the value of the **rulesPackageArn** property of the  Finding data type.

        

      
        - *(string) --* 

        
    
      - **attributes** *(list) --* 

        For a record to match a filter, the list of values that are specified for this data type property must be contained in the list of values of the **attributes** property of the  Finding data type.

        

      
        - *(dict) --* 

          This data type is used as a request parameter in the  AddAttributesToFindings and  CreateAssessmentTemplate actions.

          

        
          - **key** *(string) --* **[REQUIRED]** 

            The attribute key.

            

          
          - **value** *(string) --* 

            The value assigned to the attribute key.

            

          
        
    
      - **userAttributes** *(list) --* 

        For a record to match a filter, the value that is specified for this data type property must be contained in the list of values of the **userAttributes** property of the  Finding data type.

        

      
        - *(dict) --* 

          This data type is used as a request parameter in the  AddAttributesToFindings and  CreateAssessmentTemplate actions.

          

        
          - **key** *(string) --* **[REQUIRED]** 

            The attribute key.

            

          
          - **value** *(string) --* 

            The value assigned to the attribute key.

            

          
        
    
      - **creationTimeRange** *(dict) --* 

        The time range during which the finding is generated.

        

      
        - **beginDate** *(datetime) --* 

          The minimum value of the timestamp range.

          

        
        - **endDate** *(datetime) --* 

          The maximum value of the timestamp range.

          

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

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

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

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

        

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

      
      ::

        {
            'findingArns': [
                'string',
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **findingArns** *(list) --* 

          A list of ARNs that specifies the findings returned by the action.

          
          

          - *(string) --* 
      
        

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

          A token to resume pagination.

          
    