MigrationHub / Paginator / ListMigrationTaskUpdates

ListMigrationTaskUpdates

class MigrationHub.Paginator.ListMigrationTaskUpdates

paginator = client.get_paginator('list_migration_task_updates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHub.Client.list_migration_task_updates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ProgressUpdateStream='string',
    MigrationTaskName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ProgressUpdateStream (string) –

  [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.

• MigrationTaskName (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    '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) –

  • 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.