mgn / Paginator / ListNetworkMigrationDeployedStacks

ListNetworkMigrationDeployedStacks

class mgn.Paginator.ListNetworkMigrationDeployedStacks

paginator = client.get_paginator('list_network_migration_deployed_stacks')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='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.

• 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': [
        {
            'status': 'CREATE_COMPLETE'|'CREATE_FAILED'|'CREATE_STARTED'|'DELETE_COMPLETE'|'DELETE_FAILED'|'DELETE_STARTED',
            'stackPhysicalID': 'string',
            'stackLogicalID': 'string',
            'segmentID': 'string',
            'targetAccount': 'string',
            'failedResources': [
                {
                    'logicalID': 'string',
                    'status': 'CREATE_FAILED'|'DELETE_FAILED',
                    'statusReason': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of deployed stack details including status and resources.

    • (dict) –

      Details about a CloudFormation stack that has been deployed as part of the network migration.

      • status (string) –

        The current status of the deployed stack.

      • stackPhysicalID (string) –

        The physical ID of the CloudFormation stack.

      • stackLogicalID (string) –

        The logical ID of the stack.

      • segmentID (string) –

        The ID of the segment that this stack was deployed for.

      • targetAccount (string) –

        The target AWS account where the stack was deployed.

      • failedResources (list) –

        A list of resources that failed to deploy.

        • (dict) –

          Details about a resource that failed to deploy.

          • logicalID (string) –

            The logical ID of the failed resource.

          • status (string) –

            The status of the failed resource.

          • statusReason (string) –

            The reason why the resource failed.

  • NextToken (string) –

    A token to resume pagination.