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

***********
ListExports
***********



.. py:class:: mgn.Paginator.ListExports

  ::

    
    paginator = client.get_paginator('list_exports')

  
  

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

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

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


    **Request Syntax**
    ::

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

      List exports request filters.

      

    
      - **exportIDs** *(list) --* 

        List exports request filters export 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': [
                {
                    'exportID': 'string',
                    'arn': 'string',
                    's3Bucket': 'string',
                    's3Key': 'string',
                    's3BucketOwner': 'string',
                    'creationDateTime': 'string',
                    'endDateTime': 'string',
                    'status': 'PENDING'|'STARTED'|'FAILED'|'SUCCEEDED',
                    'progressPercentage': ...,
                    'summary': {
                        'serversCount': 123,
                        'applicationsCount': 123,
                        'wavesCount': 123
                    },
                    'tags': {
                        'string': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        List export response.

        
        

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

          List export response items.

          
          

          - *(dict) --* 

            Export task.

            
            

            - **exportID** *(string) --* 

              Export task id.

              
            

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

              ExportTask arn.

              
            

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

              Export task s3 bucket.

              
            

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

              Export task s3 key.

              
            

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

              Export task s3 bucket owner.

              
            

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

              Export task creation datetime.

              
            

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

              Export task end datetime.

              
            

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

              Export task status.

              
            

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

              Export task progress percentage.

              
            

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

              Export task summary.

              
              

              - **serversCount** *(integer) --* 

                Export task summary servers count.

                
              

              - **applicationsCount** *(integer) --* 

                Export task summary applications count.

                
              

              - **wavesCount** *(integer) --* 

                Export task summary waves count.

                
          
            

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

              Export task tags.

              
              

              - *(string) --* 
                

                - *(string) --* 
          
        
        
      
        

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

          A token to resume pagination.

          
    