:doc:`MigrationHub <../../mgh>` / Client / list_migration_task_updates

***************************
list_migration_task_updates
***************************



.. py:method:: MigrationHub.Client.list_migration_task_updates(**kwargs)

  

  This is a paginated API that returns all the migration-task states for the specified ``MigrationTaskName`` and ``ProgressUpdateStream``.

  

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


  **Request Syntax**
  ::

    response = client.list_migration_task_updates(
        ProgressUpdateStream='string',
        MigrationTaskName='string',
        NextToken='string',
        MaxResults=123
    )
    
  :type ProgressUpdateStream: string
  :param ProgressUpdateStream: **[REQUIRED]** 

    The name of the progress-update stream, which is used for access control as well as a namespace for migration-task names that is implicitly linked to your AWS account. The progress-update stream must uniquely identify the migration tool as it is used for all updates made by the tool; however, it does not need to be unique for each AWS account because it is scoped to the AWS account.

    

  
  :type MigrationTaskName: string
  :param MigrationTaskName: **[REQUIRED]** 

    A unique identifier that references the migration task. *Do not include sensitive data in this field.*

    

  
  :type NextToken: string
  :param NextToken: 

    If ``NextToken`` was returned by a previous call, there are more results available. The value of ``NextToken`` is a unique pagination token for each page. To retrieve the next page of results, specify the ``NextToken`` value that the previous call returned. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to include in the response. If more results exist than the value that you specify here for ``MaxResults``, the response will include a token that you can use to retrieve the next set of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'NextToken': 'string',
          'MigrationTaskUpdateList': [
              {
                  'UpdateDateTime': datetime(2015, 1, 1),
                  'UpdateType': 'MIGRATION_TASK_STATE_UPDATED',
                  'MigrationTaskState': {
                      'Status': 'NOT_STARTED'|'IN_PROGRESS'|'FAILED'|'COMPLETED',
                      'StatusDetail': 'string',
                      'ProgressPercent': 123
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If the response includes a ``NextToken`` value, that means that there are more results available. The value of ``NextToken`` is a unique pagination token for each page. To retrieve the next page of results, call this API again and specify this ``NextToken`` value in the request. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

        
      

      - **MigrationTaskUpdateList** *(list) --* 

        The list of migration-task updates.

        
        

        - *(dict) --* 

          A migration-task progress update.

          
          

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

            The timestamp for the update.

            
          

          - **UpdateType** *(string) --* 

            The type of the update.

            
          

          - **MigrationTaskState** *(dict) --* 

            Task object encapsulating task information.

            
            

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

              Status of the task - Not Started, In-Progress, Complete.

              
            

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

              Details of task status as notified by a migration tool. A tool might use this field to provide clarifying information about the status that is unique to that tool or that explains an error state.

              
            

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

              Indication of the percentage completion of the task.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`MigrationHub.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`MigrationHub.Client.exceptions.ThrottlingException`

  
  *   :py:class:`MigrationHub.Client.exceptions.InternalServerError`

  
  *   :py:class:`MigrationHub.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`MigrationHub.Client.exceptions.InvalidInputException`

  
  *   :py:class:`MigrationHub.Client.exceptions.ResourceNotFoundException`

  