mgn / Paginator / ListNetworkMigrationCodeGenerationSegments

ListNetworkMigrationCodeGenerationSegments

class mgn.Paginator.ListNetworkMigrationCodeGenerationSegments

paginator = client.get_paginator('list_network_migration_code_generation_segments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from mgn.Client.list_network_migration_code_generation_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 code generation 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'|'NETWORK',
            'logicalID': 'string',
            'mapperSegmentID': 'string',
            'artifacts': [
                {
                    'artifactID': 'string',
                    'artifactType': 'CDK_TYPESCRIPT'|'CLOUDFORMATION_TEMPLATE'|'CDKTF_TYPESCRIPT'|'TERRAFORM_CONFIGURATION'|'CDK_L2_TYPESCRIPT',
                    'artifactSubType': 'APPLICATION'|'NESTED_STACK'|'STACK',
                    'logicalID': 'string',
                    'outputS3Configuration': {
                        's3Bucket': 'string',
                        's3BucketOwner': 'string',
                        's3Key': 'string'
                    },
                    'checksum': {
                        'encryptionAlgorithm': 'SHA256',
                        'hash': 'string'
                    },
                    'createdAt': datetime(2015, 1, 1)
                },
            ],
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of network migration code generation segments.

    • (dict) –

      A segment of generated code representing a logical grouping of infrastructure resources.

      • jobID (string) –

        The unique identifier of the code generation job.

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

      • logicalID (string) –

        The logical identifier for the segment.

      • mapperSegmentID (string) –

        The ID of the mapper segment that this code generation segment was created from.

      • artifacts (list) –

        A list of artifacts generated for this segment.

        • (dict) –

          An artifact generated during code generation, such as a CloudFormation template or Terraform file.

          • artifactID (string) –

            The unique identifier of the artifact.

          • artifactType (string) –

            The type of the artifact, such as CLOUDFORMATION_TEMPLATE or TERRAFORM_MODULE.

          • artifactSubType (string) –

            The sub-type of the artifact for further classification.

          • logicalID (string) –

            The logical identifier for the artifact.

          • outputS3Configuration (dict) –

            The S3 location where the artifact is 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.

          • checksum (dict) –

            The checksum of the artifact for integrity verification.

            • encryptionAlgorithm (string) –

              The encryption algorithm used to generate the checksum.

            • hash (string) –

              The hash value of the checksum.

          • createdAt (datetime) –

            The timestamp when the artifact was created.

      • createdAt (datetime) –

        The timestamp when the segment was created.

  • NextToken (string) –

    A token to resume pagination.