mgn / Client / list_network_migration_deployed_stacks

list_network_migration_deployed_stacks

mgn.Client.list_network_migration_deployed_stacks(**kwargs)

Lists CloudFormation stacks that have been deployed as part of the network migration.

See also: AWS API Documentation

Request Syntax

response = client.list_network_migration_deployed_stacks(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    maxResults=123,
    nextToken='string'
)
Parameters:
  • networkMigrationExecutionID (string) –

    [REQUIRED]

    The unique identifier of the network migration execution.

  • networkMigrationDefinitionID (string) –

    [REQUIRED]

    The unique identifier of the network migration definition.

  • 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': [
        {
            '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) –

      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