Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ModifyConversionConfiguration

Modifies the specified schema conversion configuration using the provided parameters.

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

Request Syntax


{
   "ConversionConfiguration": "string",
   "MigrationProjectIdentifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConversionConfiguration

A JSON string that contains the schema conversion settings to update. For the format and available settings, see Specifying schema conversion settings for migration projects.

Usage:

Include only the sections and keys to change. The operation merges supplied values with the existing configuration.

Type: String

Required: Yes

MigrationProjectIdentifier

The migration project name or Amazon Resource Name (ARN).

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "MigrationProjectIdentifier": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MigrationProjectIdentifier

The name or Amazon Resource Name (ARN) of the modified configuration.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

message

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400

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.

Sample Request


POST / HTTP/1.1
Host: dms.<region>.<domain>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<SignedHeaders>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: AmazonDMSv20160101.ModifyConversionConfiguration
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "ConversionConfiguration": "{\"Common project settings\":{\"EnableGenAiConversion\":true},\"MSSQL_TO_AURORA_POSTGRESQL\":{\"ConvertProceduresToFunction\":false}}"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
}