:doc:`CloudFormation <../../cloudformation>` / Paginator / ListResourceScans

*****************
ListResourceScans
*****************



.. py:class:: CloudFormation.Paginator.ListResourceScans

  ::

    
    paginator = client.get_paginator('list_resource_scans')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CloudFormation.Client.list_resource_scans`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudformation-2010-05-15/ListResourceScans>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ScanTypeFilter='FULL'|'PARTIAL',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ScanTypeFilter: string
    :param ScanTypeFilter: 

      The scan type that you want to get summary information about. The default is ``FULL``.

      

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

      
      ::

        {
            'ResourceScanSummaries': [
                {
                    'ResourceScanId': 'string',
                    'Status': 'IN_PROGRESS'|'FAILED'|'COMPLETE'|'EXPIRED',
                    'StatusReason': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'EndTime': datetime(2015, 1, 1),
                    'PercentageCompleted': 123.0,
                    'ScanType': 'FULL'|'PARTIAL'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ResourceScanSummaries** *(list) --* 

          The list of scans returned.

          
          

          - *(dict) --* 

            A summary of the resource scan. This is returned by the ``ListResourceScan`` API action.

            
            

            - **ResourceScanId** *(string) --* 

              The Amazon Resource Name (ARN) of the resource scan.

              
            

            - **Status** *(string) --* 

              Status of the resource scan.

                 IN_PROGRESS   

              The resource scan is still in progress.

                 COMPLETE   

              The resource scan is complete.

                 EXPIRED   

              The resource scan has expired.

                 FAILED   

              The resource scan has failed.

              
            

            - **StatusReason** *(string) --* 

              The reason for the resource scan status, providing more information if a failure happened.

              
            

            - **StartTime** *(datetime) --* 

              The time that the resource scan was started.

              
            

            - **EndTime** *(datetime) --* 

              The time that the resource scan was finished.

              
            

            - **PercentageCompleted** *(float) --* 

              The percentage of the resource scan that has been completed.

              
            

            - **ScanType** *(string) --* 

              The scan type that has been completed.

              
        
      
    