ModifyDataProvider - AWS Database Migration Service


Modifies the specified data provider using the provided settings.


You must remove the data provider from all migration projects before you can modify it.

Request Syntax

{ "DataProviderIdentifier": "string", "DataProviderName": "string", "Description": "string", "Engine": "string", "ExactSettings": boolean, "Settings": { ... } }

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.


The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.

Type: String

Required: Yes


The name of the data provider.

Type: String

Required: No


A user-friendly description of the data provider.

Type: String

Required: No


The type of database engine for the data provider. Valid values include "aurora", "aurora-postgresql", "mysql", "oracle", "postgres", "sqlserver", redshift, mariadb, mongodb, and docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.

Type: String

Required: No


If this attribute is Y, the current call to ModifyDataProvider replaces all existing data provider settings with the exact settings that you specify in this call. If this attribute is N, the current call to ModifyDataProvider does two things:

  • It replaces any data provider settings that already exist with new values, for settings with the same names.

  • It creates new data provider settings that you specify in the call, for settings with different names.

Type: Boolean

Required: No


The settings in JSON format for a data provider.

Type: DataProviderSettings object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax

{ "DataProvider": { "DataProviderArn": "string", "DataProviderCreationTime": "string", "DataProviderName": "string", "Description": "string", "Engine": "string", "Settings": { ... } } }

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.


The data provider that was modified.

Type: DataProvider object


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


AWS DMS was denied access to the endpoint. Check that the role is correctly configured.

HTTP Status Code: 400


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

HTTP Status Code: 400


The resource could not be found.

HTTP Status Code: 400



This example illustrates one usage of ModifyDataProvider.

Sample Request

{ "DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345", "DataProviderName": "new-name", "Engine": "sqlserver", "Description": "description", "Settings": { "MicrosoftSqlServerSettings": { "ServerName": "ServerName2", "Port": 11112, "DatabaseName": "DatabaseName", "SslMode": "none" } }, "Tags": [ { "Key": "access", "Value": "authorizedusers" } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: