mgn / Client / start_network_migration_mapping_update

start_network_migration_mapping_update¶

mgn.Client.start_network_migration_mapping_update(**kwargs)¶

Starts a job to apply customer modifications to network migration mappings, such as changing properties.

Request Syntax

response = client.start_network_migration_mapping_update(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    constructs=[
        {
            'segmentID': 'string',
            'constructID': 'string',
            'constructType': 'string',
            'operation': {
                'merge': {
                    'mergeConstructs': [
                        {
                            'segmentID': 'string',
                            'constructID': 'string'
                        },
                    ]
                },
                'split': {
                    'splitConstructs': [
                        {
                            'cidrBlock': 'string'
                        },
                    ]
                },
                'delete': {}
                ,
                'update': {
                    'name': 'string',
                    'excluded': True|False,
                    'properties': {
                        'string': 'string'
                    }
                }
            }
        },
    ],
    segments=[
        {
            'segmentID': 'string',
            'targetAccount': 'string',
            'scopeTags': {
                'string': 'string'
            }
        },
    ]
)

Parameters:

networkMigrationExecutionID (string) –
[REQUIRED]

The unique identifier of the network migration execution.
networkMigrationDefinitionID (string) –
[REQUIRED]

The unique identifier of the network migration definition.
constructs (list) –
A list of construct updates to apply.
- (dict) –
  
  A construct update to apply during a mapping update operation.
  - segmentID (string) – [REQUIRED]
    
    The ID of the segment containing the construct.
  - constructID (string) – [REQUIRED]
    
    The ID of the construct to update.
  - constructType (string) – [REQUIRED]
    
    The type of the construct.
  - operation (dict) –
    
    The operation to perform on the construct.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: merge, split, delete, update.
    - merge (dict) –
      
      A merge operation to combine constructs from different segments.
      - mergeConstructs (list) –
        
        The list of constructs to merge into the target.
        
        (dict) –
        
        A construct reference specifying the source segment and construct to merge.
        
        segmentID (string) –
        
        The segment ID of the construct to merge.
        
        constructID (string) –
        
        The construct ID to merge.
    - split (dict) –
      
      A split operation to divide a construct into multiple constructs with specified CIDR blocks.
      - splitConstructs (list) –
        
        The list of split targets with their CIDR blocks.
        
        (dict) –
        
        A split target specifying the CIDR block for the new construct.
        
        cidrBlock (string) –
        
        The CIDR block for the split construct.
    - delete (dict) –
      
      A delete operation to remove a construct from the mapping.
    - update (dict) –
      
      An update operation to modify construct properties.
      - name (string) –
        
        The updated name for the construct.
      - excluded (boolean) –
        
        Whether to exclude this construct from the migration.
      - properties (dict) –
        
        The properties to update on the construct.
        
        (string) –
        
        (string) –
segments (list) –
A list of segment updates to apply.
- (dict) –
  
  A segment update to apply during a mapping update operation.
  - segmentID (string) – [REQUIRED]
    
    The ID of the segment to update.
  - targetAccount (string) –
    
    The updated target AWS account for the segment.
  - scopeTags (dict) –
    
    The updated scope tags for the segment.
    - (string) –
      - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'jobID': 'string'
}

Response Structure

(dict) –
- jobID (string) –
  
  The unique identifier of the mapping update job that was started.

Exceptions

mgn.Client.exceptions.ResourceNotFoundException
mgn.Client.exceptions.ThrottlingException
mgn.Client.exceptions.AccessDeniedException
mgn.Client.exceptions.ValidationException
mgn.Client.exceptions.ServiceQuotaExceededException
mgn.Client.exceptions.ConflictException