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.

See also: AWS API Documentation

Request Syntax

response = client.start_network_migration_mapping_update(
    networkMigrationExecutionID='string',
    networkMigrationDefinitionID='string',
    constructs=[
        {
            'segmentID': 'string',
            'constructID': 'string',
            'constructType': 'string',
            'operation': {
                'update': {
                    '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: update.

        • update (dict) –

          An update operation to modify construct properties.

          • 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