:doc:`mgn <../../mgn>` / Paginator / ListImports

***********
ListImports
***********



.. py:class:: mgn.Paginator.ListImports

  ::

    
    paginator = client.get_paginator('list_imports')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`mgn.Client.list_imports`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/mgn-2020-02-26/ListImports>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters={
              'importIDs': [
                  'string',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: dict
    :param filters: 

      List imports request filters.

      

    
      - **importIDs** *(list) --* 

        List imports request filters import IDs.

        

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

      
      ::

        {
            'items': [
                {
                    'importID': 'string',
                    'arn': 'string',
                    's3BucketSource': {
                        's3Bucket': 'string',
                        's3Key': 'string',
                        's3BucketOwner': 'string'
                    },
                    'creationDateTime': 'string',
                    'endDateTime': 'string',
                    'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
                    'progressPercentage': ...,
                    'summary': {
                        'waves': {
                            'createdCount': 123,
                            'modifiedCount': 123
                        },
                        'applications': {
                            'createdCount': 123,
                            'modifiedCount': 123
                        },
                        'servers': {
                            'createdCount': 123,
                            'modifiedCount': 123
                        }
                    },
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        List import response.

        
        

        - **items** *(list) --* 

          List import response items.

          
          

          - *(dict) --* 

            Import task.

            
            

            - **importID** *(string) --* 

              Import task id.

              
            

            - **arn** *(string) --* 

              ImportTask arn.

              
            

            - **s3BucketSource** *(dict) --* 

              Import task s3 bucket source.

              
              

              - **s3Bucket** *(string) --* 

                S3 bucket source s3 bucket.

                
              

              - **s3Key** *(string) --* 

                S3 bucket source s3 key.

                
              

              - **s3BucketOwner** *(string) --* 

                S3 bucket source s3 bucket owner.

                
          
            

            - **creationDateTime** *(string) --* 

              Import task creation datetime.

              
            

            - **endDateTime** *(string) --* 

              Import task end datetime.

              
            

            - **status** *(string) --* 

              Import task status.

              
            

            - **progressPercentage** *(float) --* 

              Import task progress percentage.

              
            

            - **summary** *(dict) --* 

              Import task summary.

              
              

              - **waves** *(dict) --* 

                Import task summary waves.

                
                

                - **createdCount** *(integer) --* 

                  Import task summery waves created count.

                  
                

                - **modifiedCount** *(integer) --* 

                  Import task summery waves modified count.

                  
            
              

              - **applications** *(dict) --* 

                Import task summary applications.

                
                

                - **createdCount** *(integer) --* 

                  Import task summary applications created count.

                  
                

                - **modifiedCount** *(integer) --* 

                  Import task summary applications modified count.

                  
            
              

              - **servers** *(dict) --* 

                Import task summary servers.

                
                

                - **createdCount** *(integer) --* 

                  Import task summary servers created count.

                  
                

                - **modifiedCount** *(integer) --* 

                  Import task summary servers modified count.

                  
            
          
            

            - **tags** *(dict) --* 

              Import task tags.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    