mgn / Paginator / ListNetworkMigrationAnalysisResults

ListNetworkMigrationAnalysisResults

class mgn.Paginator.ListNetworkMigrationAnalysisResults

paginator = client.get_paginator('list_network_migration_analysis_results')

paginate(**kwargs)

Creates an iterator that will paginate through responses from mgn.Client.list_network_migration_analysis_results().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    filters={
        'vpcIDs': [
            'string',
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• networkMigrationExecutionID (string) –

  [REQUIRED]

  The unique identifier of the network migration execution.

• networkMigrationDefinitionID (string) –

  [REQUIRED]

  The unique identifier of the network migration definition.

• filters (dict) –

  Filters to apply when listing analysis results, such as VPC IDs.

  • vpcIDs (list) –

    A list of VPC IDs to filter results by.

    • (string) –

• 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

{
    'items': [
        {
            'jobID': 'string',
            'networkMigrationExecutionID': 'string',
            'networkMigrationDefinitionID': 'string',
            'analyzerType': 'REACHABILITY_ANALYZER',
            'source': {
                'vpcID': 'string',
                'subnetID': 'string'
            },
            'target': {
                'vpcID': 'string',
                'subnetID': 'string'
            },
            'status': 'PENDING'|'STARTED'|'SUCCEEDED'|'FAILED',
            'analysisResult': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of network migration analysis results.

    • (dict) –

      The result of a network migration analysis operation.

      • jobID (string) –

        The unique identifier of the analysis job that generated this result.

      • networkMigrationExecutionID (string) –

        The unique identifier of the network migration execution.

      • networkMigrationDefinitionID (string) –

        The unique identifier of the network migration definition.

      • analyzerType (string) –

        The type of analyzer that generated this result.

      • source (dict) –

        The source resource that was analyzed.

        • vpcID (string) –

          The VPC ID of the source resource.

        • subnetID (string) –

          The subnet ID of the source resource.

      • target (dict) –

        The target resource in the analysis.

        • vpcID (string) –

          The VPC ID of the target resource.

        • subnetID (string) –

          The subnet ID of the target resource.

      • status (string) –

        The status of the analysis result.

      • analysisResult (string) –

        The detailed analysis findings and recommendations.

  • NextToken (string) –

    A token to resume pagination.