:doc:`CodeGuruSecurity <../../codeguru-security>` / Paginator / ListScans

*********
ListScans
*********



.. py:class:: CodeGuruSecurity.Paginator.ListScans

  ::

    
    paginator = client.get_paginator('list_scans')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeGuruSecurity.Client.list_scans`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codeguru-security-2018-05-10/ListScans>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'summaries': [
                {
                    'scanState': 'InProgress'|'Successful'|'Failed',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'scanName': 'string',
                    'runId': 'string',
                    'scanNameArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **summaries** *(list) --* 

          A list of ``ScanSummary`` objects with information about all scans in an account.

          
          

          - *(dict) --* 

            Information about a scan.

            
            

            - **scanState** *(string) --* 

              The state of the scan. A scan can be ``In Progress``, ``Complete``, or ``Failed``.

              
            

            - **createdAt** *(datetime) --* 

              The time when the scan was created.

              
            

            - **updatedAt** *(datetime) --* 

              The time the scan was last updated. A scan is updated when it is re-run.

              
            

            - **scanName** *(string) --* 

              The name of the scan.

              
            

            - **runId** *(string) --* 

              The identifier for the scan run.

              
            

            - **scanNameArn** *(string) --* 

              The ARN for the scan name.

              
        
      
        

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

          A token to resume pagination.

          
    