mgn / Client / list_network_migration_mapper_segment_constructs

list_network_migration_mapper_segment_constructs

mgn.Client.list_network_migration_mapper_segment_constructs(**kwargs)

Lists constructs within a mapper segment, representing individual infrastructure components like VPCs, subnets, or security groups.

See also: AWS API Documentation

Request Syntax

response = client.list_network_migration_mapper_segment_constructs(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    segmentID='string',
    filters={
        'constructIDs': [
            'string',
        ],
        'constructTypes': [
            '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.

  • segmentID (string) –

    [REQUIRED]

    The unique identifier of the segment to list constructs for.

  • filters (dict) –

    Filters to apply when listing constructs, such as construct type or ID.

    • constructIDs (list) –

      A list of construct IDs to filter by.

      • (string) –

    • constructTypes (list) –

      A list of construct types 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': [
        {
            'constructID': 'string',
            'constructType': 'string',
            'name': 'string',
            'description': 'string',
            'logicalID': 'string',
            'excluded': True|False,
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'properties': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of mapper segment constructs.

      • (dict) –

        Represents a construct within a mapper segment. A construct is an individual infrastructure component such as a VPC, subnet, security group, route table, or other network resource that is part of the network migration.

        • constructID (string) –

          The unique identifier of the construct.

        • constructType (string) –

          The type of the construct, such as VPC, subnet, security group, or route table.

        • name (string) –

          The name of the construct.

        • description (string) –

          A description of the construct.

        • logicalID (string) –

          The logical identifier for the construct in the infrastructure code.

        • excluded (boolean) –

          Whether this construct is excluded from the migration.

        • createdAt (datetime) –

          The timestamp when the construct was created.

        • updatedAt (datetime) –

          The timestamp when the construct was last updated.

        • properties (dict) –

          The properties and configuration of the construct.

          • (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