ListMigrationTasks

class MigrationHub.Paginator.ListMigrationTasks
paginator = client.get_paginator('list_migration_tasks')
paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ResourceName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • ResourceName (string) -- Filter migration tasks by discovered resource name.
  • 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

{
    '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.