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

DescribeConversionConfiguration

Returns configuration parameters for a schema conversion project.

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

Request Syntax


{
   "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.

MigrationProjectIdentifier

The name or Amazon Resource Name (ARN) for the schema conversion project to describe.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "ConversionConfiguration": "string",
   "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.

ConversionConfiguration

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

Type: String

MigrationProjectIdentifier

The name or Amazon Resource Name (ARN) for the schema conversion project.

Type: String

Errors

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

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400

Examples

Retrieving conversion configuration for a migration project

The following example retrieves the conversion configuration 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.DescribeConversionConfiguration
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
}

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",
    "ConversionConfiguration": "{\"Common project settings\":{\"ShowSeverityLevelInSql\":\"CRITICAL\",\"EnableGenAiConversion\":false},\"MSSQL_TO_AURORA_POSTGRESQL\":{\"ConvertProceduresToFunction\":true,\"UniqueIndexGeneration\":true,\"CaseSensitivityNames\":false},\"Conversion version\":{\"MSSQL_TO_AURORA_POSTGRESQL_target_engine_version\":\"15\"}}"
}