Skip to content

modify_conversion_configuration

modify_conversion_configuration(
    migration_project_identifier: MigrationProjectIdentifier,
    conversion_configuration: String,
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> ModifyConversionConfigurationResponse

Modifies the specified schema conversion configuration using the provided parameters.

Required permissions: dms:UpdateConversionConfiguration. For more information, see Actions, resources, and condition keys for Database Migration Service.

Parameters:

Raises:

Examples:

Modifying conversion configuration for a migration project The following example enables generative AI assisted conversion and updates a conversion pair setting for a migration project.

>>> client.modify_conversion_configuration(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS', conversion_configuration='{"Common project settings":{"EnableGenAiConversion":true},"MSSQL_TO_AURORA_POSTGRESQL":{"ConvertProceduresToFunction":false}}')
Source code in docs_src/capo_database_migration_service/_services/database_migration_service.py
def modify_conversion_configuration(
    self,
    migration_project_identifier: "capo_database_migration_service.types.migration_project_identifier.MigrationProjectIdentifier",
    conversion_configuration: "capo_database_migration_service.types.string.String",
    *,
    config_overrides: Optional[DatabaseMigrationServiceClientConfig] = None,
) -> "capo_database_migration_service.types.modify_conversion_configuration_response.ModifyConversionConfigurationResponse":
    """<p>Modifies the specified schema conversion configuration using the provided parameters. </p> <p> <b>Required permissions:</b> <code>dms:UpdateConversionConfiguration</code>. For more information, see <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsdatabasemigrationservice.html">Actions, resources, and condition keys for Database Migration Service</a>.</p>

    Args:
        migration_project_identifier: <p>The migration project name or Amazon Resource Name (ARN).</p>
        conversion_configuration: <p>A JSON string that contains the schema conversion settings to update. For the format and available settings, see <a href="https://docs.aws.amazon.com/dms/latest/userguide/schema-conversion-settings.html">Specifying schema conversion settings for migration projects</a>.</p> <p>Usage:</p> <ul> <li> <p>Include only the sections and keys to change. The operation merges supplied values with the existing configuration.</p> </li> </ul>

    Raises:
        capo_database_migration_service.errors.invalid_resource_state_fault.InvalidResourceStateFault: <p>The resource is in a state that prevents it from being used for database migration.</p>
        capo_database_migration_service.errors.resource_not_found_fault.ResourceNotFoundFault: <p>The resource could not be found.</p>
        capo_database_migration_service.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Modifying conversion configuration for a migration project
        The following example enables generative AI assisted conversion and updates a conversion pair setting for a migration project.

        >>> client.modify_conversion_configuration(migration_project_identifier='arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS', conversion_configuration='{"Common project settings":{"EnableGenAiConversion":true},"MSSQL_TO_AURORA_POSTGRESQL":{"ConvertProceduresToFunction":false}}')
    """

    def _handler(
        req: "OperationRequest[capo_database_migration_service.types.modify_conversion_configuration_message.ModifyConversionConfigurationMessage]",
    ) -> OperationResponse[
        "capo_database_migration_service.types.modify_conversion_configuration_response.ModifyConversionConfigurationResponse"
    ]:
        import capo_database_migration_service._operations.amazon_dm_sv20160101.modify_conversion_configuration

        output, http_response = (
            capo_database_migration_service._operations.amazon_dm_sv20160101.modify_conversion_configuration.modify_conversion_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ModifyConversionConfiguration")
    )
    input_: capo_database_migration_service.types.modify_conversion_configuration_message.ModifyConversionConfigurationMessage = {
        "migration_project_identifier": migration_project_identifier,
        "conversion_configuration": conversion_configuration,
    }

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