MigrationHub / Client / list_migration_tasks

list_migration_tasks#

MigrationHub.Client.list_migration_tasks(**kwargs)#

Lists all, or filtered by resource name, migration tasks associated with the user account making this call. This API has the following traits:

  • Can show a summary list of the most recent migration tasks.

  • Can show a summary list of migration tasks associated with a given discovered resource.

  • Lists migration tasks in a paginated interface.

See also: AWS API Documentation

Request Syntax

response = client.list_migration_tasks(
    NextToken='string',
    MaxResults=123,
    ResourceName='string'
)
Parameters:

  • NextToken (string) – If a NextToken was returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in NextToken.

  • MaxResults (integer) – Value to specify how many results are returned per page.

  • ResourceName (string) – Filter migration tasks by discovered resource name.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      If there are more migration tasks than the max result, return the next token to be passed to the next call as a bookmark of where to start from.

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

Exceptions