mgn / Client / update_network_migration_mapper_segment

update_network_migration_mapper_segment

mgn.Client.update_network_migration_mapper_segment(**kwargs)

Updates a mapper segment’s configuration, such as changing its scope tags.

See also: AWS API Documentation

Request Syntax

response = client.update_network_migration_mapper_segment(
    networkMigrationDefinitionID='string',
    networkMigrationExecutionID='string',
    segmentID='string',
    scopeTags={
        'string': 'string'
    }
)
Parameters:
  • networkMigrationDefinitionID (string) –

    [REQUIRED]

    The unique identifier of the network migration definition.

  • networkMigrationExecutionID (string) –

    [REQUIRED]

    The unique identifier of the network migration execution.

  • segmentID (string) –

    [REQUIRED]

    The unique identifier of the segment to update.

  • scopeTags (dict) –

    The updated scope tags for the segment.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    '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',
    ]
}

Response Structure

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

Exceptions

  • mgn.Client.exceptions.ResourceNotFoundException

  • mgn.Client.exceptions.AccessDeniedException

  • mgn.Client.exceptions.ValidationException