Skip to content

update_network_migration_mapper_segment

update_network_migration_mapper_segment(
    network_migration_definition_id: NetworkMigrationDefinitionID,
    network_migration_execution_id: NetworkMigrationExecutionID,
    segment_id: SegmentID,
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    scope_tags: Optional[ScopeTagsMap] = None,
) -> NetworkMigrationMapperSegment

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

Parameters:

  • network_migration_definition_id (NetworkMigrationDefinitionID) –

    The unique identifier of the network migration definition.

  • network_migration_execution_id (NetworkMigrationExecutionID) –

    The unique identifier of the network migration execution.

  • segment_id (SegmentID) –

    The unique identifier of the segment to update.

  • scope_tags (Optional[ScopeTagsMap], default: None ) –

    The updated scope tags for the segment.

Raises:

Examples:

Sample UpdateNetworkMigrationMapperSegment call

>>> client.update_network_migration_mapper_segment(network_migration_execution_id='01234567-abcd-abcd-abcd-0123456789ab', network_migration_definition_id='nmd-01234567891234567', segment_id='12345678-abcd-abcd-efab-0123456789ab')
Source code in docs_src/capo_mgn/_services/mgn.py
def update_network_migration_mapper_segment(
    self,
    network_migration_definition_id: "capo_mgn.types.network_migration_definition_id.NetworkMigrationDefinitionID",
    network_migration_execution_id: "capo_mgn.types.network_migration_execution_id.NetworkMigrationExecutionID",
    segment_id: "capo_mgn.types.segment_id.SegmentID",
    *,
    config_overrides: Optional[mgnClientConfig] = None,
    scope_tags: Optional["capo_mgn.types.scope_tags_map.ScopeTagsMap"] = None,
) -> (
    "capo_mgn.types.network_migration_mapper_segment.NetworkMigrationMapperSegment"
):
    """<p>Updates a mapper segment's configuration, such as changing its scope tags.</p>

    Args:
        network_migration_definition_id: <p>The unique identifier of the network migration definition.</p>
        network_migration_execution_id: <p>The unique identifier of the network migration execution.</p>
        segment_id: <p>The unique identifier of the segment to update.</p>
        scope_tags: <p>The updated scope tags for the segment.</p>

    Raises:
        capo_mgn.errors.access_denied_exception.AccessDeniedException: <p>Operation denied due to a file permission or access check error.</p>
        capo_mgn.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found exception.</p>
        capo_mgn.errors.validation_exception.ValidationException: <p>Validate exception.</p>
        capo_mgn.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Sample UpdateNetworkMigrationMapperSegment call

        >>> client.update_network_migration_mapper_segment(network_migration_execution_id='01234567-abcd-abcd-abcd-0123456789ab', network_migration_definition_id='nmd-01234567891234567', segment_id='12345678-abcd-abcd-efab-0123456789ab')
    """

    def _handler(
        req: "OperationRequest[capo_mgn.types.update_network_migration_mapper_segment_request.UpdateNetworkMigrationMapperSegmentRequest]",
    ) -> OperationResponse[
        "capo_mgn.types.network_migration_mapper_segment.NetworkMigrationMapperSegment"
    ]:
        import capo_mgn._operations.application_migration_service.update_network_migration_mapper_segment

        output, http_response = (
            capo_mgn._operations.application_migration_service.update_network_migration_mapper_segment.update_network_migration_mapper_segment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mgn.types.update_network_migration_mapper_segment_request.UpdateNetworkMigrationMapperSegmentRequest",
    ) -> dict[str, Any]:
        import capo_mgn.types.update_network_migration_mapper_segment_request

        return capo_mgn.types.update_network_migration_mapper_segment_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_mgn.types.network_migration_mapper_segment.NetworkMigrationMapperSegment",
    ) -> dict[str, Any]:
        import capo_mgn.types.network_migration_mapper_segment

        return capo_mgn.types.network_migration_mapper_segment.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "UpdateNetworkMigrationMapperSegment",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_mgn.types.update_network_migration_mapper_segment_request.UpdateNetworkMigrationMapperSegmentRequest = {
        "network_migration_definition_id": network_migration_definition_id,
        "network_migration_execution_id": network_migration_execution_id,
        "segment_id": segment_id,
    }
    if scope_tags is not None:
        input_["scope_tags"] = scope_tags

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output