mgn / Paginator / ListNetworkMigrationMapperSegments

ListNetworkMigrationMapperSegments

class mgn.Paginator.ListNetworkMigrationMapperSegments

paginator = client.get_paginator('list_network_migration_mapper_segments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    filters={
        'segmentIDs': [
            '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 segments.

  • segmentIDs (list) –

    A list of segment IDs 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': [
        {
            'jobID': 'string',
            'networkMigrationExecutionID': 'string',
            'networkMigrationDefinitionID': 'string',
            'segmentID': 'string',
            'segmentType': 'WORKLOAD'|'APPLIANCE',
            'name': 'string',
            'description': 'string',
            'logicalID': 'string',
            'checksum': {
                'encryptionAlgorithm': 'SHA256',
                'hash': 'string'
            },
            'outputS3Configuration': {
                's3Bucket': 'string',
                's3BucketOwner': 'string',
                's3Key': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'scopeTags': {
                'string': 'string'
            },
            'targetAccount': 'string',
            'referencedSegments': [
                'string',
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of mapper segments.

    • (dict) –

      • jobID (string) –

        The unique identifier of the job that created this segment.

      • networkMigrationExecutionID (string) –

        The unique identifier of the network migration execution.

      • networkMigrationDefinitionID (string) –

        The unique identifier of the network migration definition.

      • segmentID (string) –

        The unique identifier of the segment.

      • segmentType (string) –

        The type of the segment, such as VPC, subnet, or security group.

      • name (string) –

        The name of the segment.

      • description (string) –

        A description of the segment.

      • logicalID (string) –

        The logical identifier for the segment in the infrastructure code.

      • checksum (dict) –

        The checksum of the segment data for integrity verification.

        • encryptionAlgorithm (string) –

          The encryption algorithm used to generate the checksum.

        • hash (string) –

          The hash value of the checksum.

      • outputS3Configuration (dict) –

        The S3 location where segment artifacts are stored.

        • s3Bucket (string) –

          The name of the S3 bucket.

        • s3BucketOwner (string) –

          The AWS account ID of the S3 bucket owner.

        • s3Key (string) –

          The S3 key (path) for the object.

      • createdAt (datetime) –

        The timestamp when the segment was created.

      • updatedAt (datetime) –

        The timestamp when the segment was last updated.

      • scopeTags (dict) –

        Scope tags for the segment.

        • (string) –

          • (string) –

      • targetAccount (string) –

        The target AWS account where this segment will be deployed.

      • referencedSegments (list) –

        A list of other segments that this segment depends on or references.

        • (string) –

  • NextToken (string) –

    A token to resume pagination.