:doc:`MigrationHub <../../mgh>` / Paginator / ListMigrationTasks

******************
ListMigrationTasks
******************



.. py:class:: MigrationHub.Paginator.ListMigrationTasks

  ::

    
    paginator = client.get_paginator('list_migration_tasks')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`MigrationHub.Client.list_migration_tasks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/AWSMigrationHub-2017-05-31/ListMigrationTasks>`_    


    **Request Syntax**
    ::

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

      Filter migration tasks by discovered resource name.

      

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

      
      ::

        {
            'MigrationTaskSummaryList': [
                {
                    'ProgressUpdateStream': 'string',
                    'MigrationTaskName': 'string',
                    'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
                    'ProgressPercent': 123,
                    'StatusDetail': 'string',
                    'UpdateDateTime': datetime(2015, 1, 1)
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **MigrationTaskSummaryList** *(list) --* 

          Lists the migration task's summary which includes: ``MigrationTaskName``, ``ProgressPercent``, ``ProgressUpdateStream``, ``Status``, and the ``UpdateDateTime`` for each task.

          
          

          - *(dict) --* 

            MigrationTaskSummary includes ``MigrationTaskName``, ``ProgressPercent``, ``ProgressUpdateStream``, ``Status``, and ``UpdateDateTime`` for each task.

            
            

            - **ProgressUpdateStream** *(string) --* 

              An AWS resource used for access control. It should uniquely identify the migration tool as it is used for all updates made by the tool.

              
            

            - **MigrationTaskName** *(string) --* 

              Unique identifier that references the migration task. *Do not store personal data in this field.*

              
            

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

              Status of the task.

              
            

            - **ProgressPercent** *(integer) --* 

              Indication of the percentage completion of the task.

              
            

            - **StatusDetail** *(string) --* 

              Detail information of what is being done within the overall status state.

              
            

            - **UpdateDateTime** *(datetime) --* 

              The timestamp when the task was gathered.

              
        
      
    