Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1469325456.8 KB

Modifies the specified endpoint.

For a MySQL source or target endpoint, don't explicitly specify the database using the DatabaseName request parameter on the ModifyEndpoint API call. Specifying DatabaseName when you modify a MySQL endpoint replicates all the task tables to this single database. For MySQL endpoints, you specify the database only when you specify the schema in the table-mapping rules of the DMS task.

post/#X-Amz-Target=AmazonDMSv20160101.ModifyEndpoint

Headers

X-Amz-Target'AmazonDMSv20160101.ModifyEndpoint' required

Request body

EndpointArnstring required

The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.

EndpointIdentifierstring

The database endpoint identifier. 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.

EndpointType'source' | 'target'

The type of endpoint. Valid values are <code>source</code> and <code>target</code>.

EngineNamestring

The database engine name. Valid values, depending on the EndpointType, include <code>"mysql"</code>, <code>"oracle"</code>, <code>"postgres"</code>, <code>"mariadb"</code>, <code>"aurora"</code>, <code>"aurora-postgresql"</code>, <code>"redshift"</code>, <code>"s3"</code>, <code>"db2"</code>, <code>"db2-zos"</code>, <code>"azuredb"</code>, <code>"sybase"</code>, <code>"dynamodb"</code>, <code>"mongodb"</code>, <code>"kinesis"</code>, <code>"kafka"</code>, <code>"elasticsearch"</code>, <code>"documentdb"</code>, <code>"sqlserver"</code>, <code>"neptune"</code>, and <code>"babelfish"</code>.

Usernamestring

The user name to be used to login to the endpoint database.

Passwordstring password

The password to be used to login to the endpoint database.

ServerNamestring

The name of the server where the endpoint database resides.

Portinteger

The port used by the endpoint database.

DatabaseNamestring

The name of the endpoint database. For a MySQL source or target endpoint, do not specify DatabaseName.

ExtraConnectionAttributesstring

Additional attributes associated with the connection. To reset this parameter, pass the empty string ("") as an argument.

CertificateArnstring

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

SslMode'none' | 'require' | 'verify-ca' | 'verify-full'

The SSL mode used to connect to the endpoint. The default value is <code>none</code>.

ServiceAccessRoleArnstring

The Amazon Resource Name (ARN) for the IAM role you want to use to modify the endpoint. The role must allow the <code>iam:PassRole</code> action.

ExternalTableDefinitionstring

The external table definition.

ExactSettingsboolean
<p>If this attribute is Y, the current call to <code>ModifyEndpoint</code> replaces all existing endpoint settings with the exact settings that you specify in this call. If this attribute is N, the current call to <code>ModifyEndpoint</code> does two things: </p> <ul> <li> <p>It replaces any endpoint settings that already exist with new values, for settings with the same names.</p> </li> <li> <p>It creates new endpoint settings that you specify in the call, for settings with different names. </p> </li> </ul> <p>For example, if you call <code>create-endpoint ... --endpoint-settings '{"a":1}' ...</code>, the endpoint has the following endpoint settings: <code>'{"a":1}'</code>. If you then call <code>modify-endpoint ... --endpoint-settings '{"b":2}' ...</code> for the same endpoint, the endpoint has the following settings: <code>'{"a":1,"b":2}'</code>. </p> <p>However, suppose that you follow this with a call to <code>modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ...</code> for that same endpoint again. Then the endpoint has the following settings: <code>'{"b":2}'</code>. All existing settings are replaced with the exact settings that you specify. </p>

Response

Success

Example response

{
  "Endpoint": {}
}