mgn / Client / list_network_migration_executions

list_network_migration_executions

mgn.Client.list_network_migration_executions(**kwargs)

Lists network migration execution instances for a given definition, showing the status and progress of each execution.

See also: AWS API Documentation

Request Syntax

response = client.list_network_migration_executions(
    networkMigrationDefinitionID='string',
    filters={
        'networkMigrationExecutionIDs': [
            'string',
        ],
        'networkMigrationExecutionStatuses': [
            'PENDING'|'STARTED'|'SUCCEEDED'|'FAILED',
        ]
    },
    nextToken='string',
    maxResults=123
)

Parameters:

• networkMigrationDefinitionID (string) –

  [REQUIRED]

  The unique identifier of the network migration definition to list executions for.

• filters (dict) –

  Filters to apply when listing executions, such as status or execution ID.

  • networkMigrationExecutionIDs (list) –

    A list of execution IDs to filter by.

    • (string) –

  • networkMigrationExecutionStatuses (list) –

    A list of execution statuses to filter by.

    • (string) –

• nextToken (string) – The token for the next page of results.

• maxResults (integer) – The maximum number of results to return in a single call.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'networkMigrationDefinitionID': 'string',
            'networkMigrationExecutionID': 'string',
            'status': 'PENDING'|'STARTED'|'SUCCEEDED'|'FAILED',
            'stage': 'MAPPING'|'CODE_GENERATION'|'DEPLOY'|'DEPLOYED_STACKS_DELETION'|'ANALYZE',
            'activity': 'MAPPING'|'MAPPING_UPDATE'|'CODE_GENERATION'|'DEPLOY'|'DEPLOYED_STACKS_DELETION'|'ANALYZE',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of network migration execution details.

    • (dict) –

      Details about a network migration execution instance.

      • networkMigrationDefinitionID (string) –

        The unique identifier of the network migration definition used by this execution.

      • networkMigrationExecutionID (string) –

        The unique identifier of the execution.

      • status (string) –

        The current status of the execution.

      • stage (string) –

        The current stage of the execution in the migration workflow.

      • activity (string) –

        The current activity being performed in the execution.

      • createdAt (datetime) –

        The timestamp when the execution was created.

      • updatedAt (datetime) –

        The timestamp when the execution was last updated.

      • tags (dict) –

        Tags assigned to the execution.

        • (string) –

          • (string) –

  • nextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Exceptions

• mgn.Client.exceptions.ResourceNotFoundException

• mgn.Client.exceptions.AccessDeniedException