mgn / Client / list_network_migration_code_generation_segments

list_network_migration_code_generation_segments

mgn.Client.list_network_migration_code_generation_segments(**kwargs)

Lists code generation segments, which represent individual infrastructure components generated as code templates.

See also: AWS API Documentation

Request Syntax

response = client.list_network_migration_code_generation_segments(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    filters={
        'segmentIDs': [
            '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.

  • filters (dict) –

    Filters to apply when listing code generation segments.

    • segmentIDs (list) –

      A list of segment IDs 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': [
        {
            '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)
                },
            ],
            'referencedSegments': [
                'string',
            ],
            '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 generated artifact.

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

        • referencedSegments (list) –

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

          • (string) –

        • createdAt (datetime) –

          The timestamp when the segment was created.

    • 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