mgn / Paginator / ListNetworkMigrationMapperSegmentConstructs

ListNetworkMigrationMapperSegmentConstructs

class mgn.Paginator.ListNetworkMigrationMapperSegmentConstructs

paginator = client.get_paginator('list_network_migration_mapper_segment_constructs')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

• 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) –

• 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': [
        {
            'constructID': 'string',
            'constructType': 'string',
            'name': 'string',
            'description': 'string',
            'logicalID': 'string',
            '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.

      • 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) –

    A token to resume pagination.