mgn / Client / list_network_migration_analyses

list_network_migration_analyses

mgn.Client.list_network_migration_analyses(**kwargs)

Lists network migration analysis jobs for a specified execution. Returns information about analysis job status and results.

See also: AWS API Documentation

Request Syntax

response = client.list_network_migration_analyses(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    filters={
        'jobIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • networkMigrationExecutionID (string) –

    [REQUIRED]

    The unique identifier of the network migration execution to list analyses for.

  • networkMigrationDefinitionID (string) –

    [REQUIRED]

    The unique identifier of the network migration definition.

  • filters (dict) –

    Filters to apply when listing analysis jobs.

    • jobIDs (list) –

      A list of job IDs to filter by.

      • (string) –

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

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

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'jobID': 'string',
            'networkMigrationExecutionID': 'string',
            'networkMigrationDefinitionID': 'string',
            'createdAt': datetime(2015, 1, 1),
            'endedAt': datetime(2015, 1, 1),
            'status': 'PENDING'|'STARTED'|'SUCCEEDED'|'FAILED',
            'statusDetails': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of network migration analysis job details.

      • (dict) –

        Details about a network migration analysis job.

        • jobID (string) –

          The unique identifier of the analysis job.

        • networkMigrationExecutionID (string) –

          The unique identifier of the network migration execution.

        • networkMigrationDefinitionID (string) –

          The unique identifier of the network migration definition.

        • createdAt (datetime) –

          The timestamp when the job was created.

        • endedAt (datetime) –

          The timestamp when the job completed or failed.

        • status (string) –

          The current status of the analysis job.

        • statusDetails (string) –

          Detailed status information about the job.

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

  • mgn.Client.exceptions.AccessDeniedException

  • mgn.Client.exceptions.ValidationException