ModifyEndpoint - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

ModifyEndpoint

Modifies the specified endpoint.

Note

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 Amazon DMS task.

Request Syntax

{ "CertificateArn": "string", "DatabaseName": "string", "DmsTransferSettings": { "BucketName": "string", "ServiceAccessRoleArn": "string" }, "DocDbSettings": { "DatabaseName": "string", "DocsToInvestigate": number, "ExtractDocId": boolean, "KmsKeyId": "string", "NestingLevel": "string", "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "Username": "string" }, "DynamoDbSettings": { "ServiceAccessRoleArn": "string" }, "ElasticsearchSettings": { "EndpointUri": "string", "ErrorRetryDuration": number, "FullLoadErrorPercentage": number, "ServiceAccessRoleArn": "string" }, "EndpointArn": "string", "EndpointIdentifier": "string", "EndpointType": "string", "EngineName": "string", "ExactSettings": boolean, "ExternalTableDefinition": "string", "ExtraConnectionAttributes": "string", "IBMDb2Settings": { "CurrentLsn": "string", "DatabaseName": "string", "MaxKBytesPerRead": number, "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "SetDataCaptureChanges": boolean, "Username": "string" }, "KafkaSettings": { "Broker": "string", "IncludeControlDetails": boolean, "IncludeNullAndEmpty": boolean, "IncludePartitionValue": boolean, "IncludeTableAlterOperations": boolean, "IncludeTransactionDetails": boolean, "MessageFormat": "string", "MessageMaxBytes": number, "NoHexPrefix": boolean, "PartitionIncludeSchemaTable": boolean, "SaslPassword": "string", "SaslUsername": "string", "SecurityProtocol": "string", "SslCaCertificateArn": "string", "SslClientCertificateArn": "string", "SslClientKeyArn": "string", "SslClientKeyPassword": "string", "Topic": "string" }, "KinesisSettings": { "IncludeControlDetails": boolean, "IncludeNullAndEmpty": boolean, "IncludePartitionValue": boolean, "IncludeTableAlterOperations": boolean, "IncludeTransactionDetails": boolean, "MessageFormat": "string", "NoHexPrefix": boolean, "PartitionIncludeSchemaTable": boolean, "ServiceAccessRoleArn": "string", "StreamArn": "string" }, "MicrosoftSQLServerSettings": { "BcpPacketSize": number, "ControlTablesFileGroup": "string", "DatabaseName": "string", "Password": "string", "Port": number, "QuerySingleAlwaysOnNode": boolean, "ReadBackupOnly": boolean, "SafeguardPolicy": "string", "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "UseBcpFullLoad": boolean, "Username": "string", "UseThirdPartyBackupDevice": boolean }, "MongoDbSettings": { "AuthMechanism": "string", "AuthSource": "string", "AuthType": "string", "DatabaseName": "string", "DocsToInvestigate": "string", "ExtractDocId": "string", "KmsKeyId": "string", "NestingLevel": "string", "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "Username": "string" }, "MySQLSettings": { "AfterConnectScript": "string", "CleanSourceMetadataOnMismatch": boolean, "DatabaseName": "string", "EventsPollInterval": number, "MaxFileSize": number, "ParallelLoadThreads": number, "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "ServerTimezone": "string", "TargetDbType": "string", "Username": "string" }, "NeptuneSettings": { "ErrorRetryDuration": number, "IamAuthEnabled": boolean, "MaxFileSize": number, "MaxRetryCount": number, "S3BucketFolder": "string", "S3BucketName": "string", "ServiceAccessRoleArn": "string" }, "OracleSettings": { "AccessAlternateDirectly": boolean, "AdditionalArchivedLogDestId": number, "AddSupplementalLogging": boolean, "AllowSelectNestedTables": boolean, "ArchivedLogDestId": number, "ArchivedLogsOnly": boolean, "AsmPassword": "string", "AsmServer": "string", "AsmUser": "string", "CharLengthSemantics": "string", "DatabaseName": "string", "DirectPathNoLog": boolean, "DirectPathParallelLoad": boolean, "EnableHomogenousTablespace": boolean, "ExtraArchivedLogDestIds": [ number ], "FailTasksOnLobTruncation": boolean, "NumberDatatypeScale": number, "OraclePathPrefix": "string", "ParallelAsmReadThreads": number, "Password": "string", "Port": number, "ReadAheadBlocks": number, "ReadTableSpaceName": boolean, "ReplacePathPrefix": boolean, "RetryInterval": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerOracleAsmAccessRoleArn": "string", "SecretsManagerOracleAsmSecretId": "string", "SecretsManagerSecretId": "string", "SecurityDbEncryption": "string", "SecurityDbEncryptionName": "string", "ServerName": "string", "SpatialDataOptionToGeoJsonFunctionName": "string", "StandbyDelayTime": number, "UseAlternateFolderForOnline": boolean, "UseBFile": boolean, "UseDirectPathFullLoad": boolean, "UseLogminerReader": boolean, "UsePathPrefix": "string", "Username": "string" }, "Password": "string", "Port": number, "PostgreSQLSettings": { "AfterConnectScript": "string", "CaptureDdls": boolean, "DatabaseName": "string", "DdlArtifactsSchema": "string", "ExecuteTimeout": number, "FailTasksOnLobTruncation": boolean, "HeartbeatEnable": boolean, "HeartbeatFrequency": number, "HeartbeatSchema": "string", "MaxFileSize": number, "Password": "string", "PluginName": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "SlotName": "string", "Username": "string" }, "RedisSettings": { "AuthPassword": "string", "AuthType": "string", "AuthUserName": "string", "Port": number, "ServerName": "string", "SslCaCertificateArn": "string", "SslSecurityProtocol": "string" }, "RedshiftSettings": { "AcceptAnyDate": boolean, "AfterConnectScript": "string", "BucketFolder": "string", "BucketName": "string", "CaseSensitiveNames": boolean, "CompUpdate": boolean, "ConnectionTimeout": number, "DatabaseName": "string", "DateFormat": "string", "EmptyAsNull": boolean, "EncryptionMode": "string", "ExplicitIds": boolean, "FileTransferUploadStreams": number, "LoadTimeout": number, "MaxFileSize": number, "Password": "string", "Port": number, "RemoveQuotes": boolean, "ReplaceChars": "string", "ReplaceInvalidChars": "string", "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "ServerSideEncryptionKmsKeyId": "string", "ServiceAccessRoleArn": "string", "TimeFormat": "string", "TrimBlanks": boolean, "TruncateColumns": boolean, "Username": "string", "WriteBufferSize": number }, "S3Settings": { "AddColumnName": boolean, "BucketFolder": "string", "BucketName": "string", "CannedAclForObjects": "string", "CdcInsertsAndUpdates": boolean, "CdcInsertsOnly": boolean, "CdcMaxBatchInterval": number, "CdcMinFileSize": number, "CdcPath": "string", "CompressionType": "string", "CsvDelimiter": "string", "CsvNoSupValue": "string", "CsvNullValue": "string", "CsvRowDelimiter": "string", "DataFormat": "string", "DataPageSize": number, "DatePartitionDelimiter": "string", "DatePartitionEnabled": boolean, "DatePartitionSequence": "string", "DictPageSizeLimit": number, "EnableStatistics": boolean, "EncodingType": "string", "EncryptionMode": "string", "ExternalTableDefinition": "string", "IgnoreHeaderRows": number, "IncludeOpForFullLoad": boolean, "MaxFileSize": number, "ParquetTimestampInMillisecond": boolean, "ParquetVersion": "string", "PreserveTransactions": boolean, "Rfc4180": boolean, "RowGroupLength": number, "ServerSideEncryptionKmsKeyId": "string", "ServiceAccessRoleArn": "string", "TimestampColumnName": "string", "UseCsvNoSupValue": boolean }, "ServerName": "string", "ServiceAccessRoleArn": "string", "SslMode": "string", "SybaseSettings": { "DatabaseName": "string", "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "Username": "string" }, "Username": "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.

CertificateArn

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

Type: String

Required: No

DatabaseName

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

Type: String

Required: No

DmsTransferSettings

The settings in JSON format for the DMS transfer type of source endpoint.

Attributes include the following:

  • serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service access IAM role. The role must allow the iam:PassRole action.

  • BucketName - The name of the S3 bucket to use.

Shorthand syntax for these settings is as follows: ServiceAccessRoleArn=string ,BucketName=string

JSON syntax for these settings is as follows: { "ServiceAccessRoleArn": "string", "BucketName": "string"}

Type: DmsTransferSettings object

Required: No

DocDbSettings

Settings in JSON format for the source DocumentDB endpoint. For more information about the available settings, see the configuration properties section in Using DocumentDB as a Target for Amazon Database Migration Service in the Amazon Database Migration Service User Guide.

Type: DocDbSettings object

Required: No

DynamoDbSettings

Settings in JSON format for the target Amazon DynamoDB endpoint. For information about other available settings, see Using Object Mapping to Migrate Data to DynamoDB in the Amazon Database Migration Service User Guide.

Type: DynamoDbSettings object

Required: No

ElasticsearchSettings

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: ElasticsearchSettings object

Required: No

EndpointArn

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

Type: String

Required: Yes

EndpointIdentifier

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.

Type: String

Required: No

EndpointType

The type of endpoint. Valid values are source and target.

Type: String

Valid Values: source | target

Required: No

EngineName

The type of engine for the endpoint. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", and "neptune".

Type: String

Required: No

ExactSettings

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

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

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

For example, if you call create-endpoint ... --endpoint-settings '{"a":1}' ..., the endpoint has the following endpoint settings: '{"a":1}'. If you then call modify-endpoint ... --endpoint-settings '{"b":2}' ... for the same endpoint, the endpoint has the following settings: '{"a":1,"b":2}'.

However, suppose that you follow this with a call to modify-endpoint ... --endpoint-settings '{"b":2}' --exact-settings ... for that same endpoint again. Then the endpoint has the following settings: '{"b":2}'. All existing settings are replaced with the exact settings that you specify.

Type: Boolean

Required: No

ExternalTableDefinition

The external table definition.

Type: String

Required: No

ExtraConnectionAttributes

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

Type: String

Required: No

IBMDb2Settings

Settings in JSON format for the source IBM Db2 LUW endpoint. For information about other available settings, see Extra connection attributes when using Db2 LUW as a source for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: IBMDb2Settings object

Required: No

KafkaSettings

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using object mapping to migrate data to a Kafka topic in the Amazon Database Migration Service User Guide.

Type: KafkaSettings object

Required: No

KinesisSettings

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using object mapping to migrate data to a Kinesis data stream in the Amazon Database Migration Service User Guide.

Type: KinesisSettings object

Required: No

MicrosoftSQLServerSettings

Settings in JSON format for the source and target Microsoft SQL Server endpoint. For information about other available settings, see Extra connection attributes when using SQL Server as a source for Amazon DMS and Extra connection attributes when using SQL Server as a target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: MicrosoftSQLServerSettings object

Required: No

MongoDbSettings

Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the configuration properties section in Endpoint configuration settings when using MongoDB as a source for Amazon Database Migration Service in the Amazon Database Migration Service User Guide.

Type: MongoDbSettings object

Required: No

MySQLSettings

Settings in JSON format for the source and target MySQL endpoint. For information about other available settings, see Extra connection attributes when using MySQL as a source for Amazon DMS and Extra connection attributes when using a MySQL-compatible database as a target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: MySQLSettings object

Required: No

NeptuneSettings

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying graph-mapping rules using Gremlin and R2RML for Amazon Neptune as a target in the Amazon Database Migration Service User Guide.

Type: NeptuneSettings object

Required: No

OracleSettings

Settings in JSON format for the source and target Oracle endpoint. For information about other available settings, see Extra connection attributes when using Oracle as a source for Amazon DMS and Extra connection attributes when using Oracle as a target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: OracleSettings object

Required: No

Password

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

Type: String

Required: No

Port

The port used by the endpoint database.

Type: Integer

Required: No

PostgreSQLSettings

Settings in JSON format for the source and target PostgreSQL endpoint. For information about other available settings, see Extra connection attributes when using PostgreSQL as a source for Amazon DMS and Extra connection attributes when using PostgreSQL as a target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: PostgreSQLSettings object

Required: No

RedisSettings

Settings in JSON format for the Redis target endpoint.

Type: RedisSettings object

Required: No

RedshiftSettings

Provides information that defines an Amazon Redshift endpoint.

Type: RedshiftSettings object

Required: No

S3Settings

Settings in JSON format for the target Amazon S3 endpoint. For more information about the available settings, see Extra Connection Attributes When Using Amazon S3 as a Target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: S3Settings object

Required: No

ServerName

The name of the server where the endpoint database resides.

Type: String

Required: No

ServiceAccessRoleArn

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

Type: String

Required: No

SslMode

The SSL mode used to connect to the endpoint. The default value is none.

Type: String

Valid Values: none | require | verify-ca | verify-full

Required: No

SybaseSettings

Settings in JSON format for the source and target SAP ASE endpoint. For information about other available settings, see Extra connection attributes when using SAP ASE as a source for Amazon DMS and Extra connection attributes when using SAP ASE as a target for Amazon DMS in the Amazon Database Migration Service User Guide.

Type: SybaseSettings object

Required: No

Username

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

Type: String

Required: No

Response Syntax

{ "Endpoint": { "CertificateArn": "string", "DatabaseName": "string", "DmsTransferSettings": { "BucketName": "string", "ServiceAccessRoleArn": "string" }, "DocDbSettings": { "DatabaseName": "string", "DocsToInvestigate": number, "ExtractDocId": boolean, "KmsKeyId": "string", "NestingLevel": "string", "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "Username": "string" }, "DynamoDbSettings": { "ServiceAccessRoleArn": "string" }, "ElasticsearchSettings": { "EndpointUri": "string", "ErrorRetryDuration": number, "FullLoadErrorPercentage": number, "ServiceAccessRoleArn": "string" }, "EndpointArn": "string", "EndpointIdentifier": "string", "EndpointType": "string", "EngineDisplayName": "string", "EngineName": "string", "ExternalId": "string", "ExternalTableDefinition": "string", "ExtraConnectionAttributes": "string", "IBMDb2Settings": { "CurrentLsn": "string", "DatabaseName": "string", "MaxKBytesPerRead": number, "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "SetDataCaptureChanges": boolean, "Username": "string" }, "KafkaSettings": { "Broker": "string", "IncludeControlDetails": boolean, "IncludeNullAndEmpty": boolean, "IncludePartitionValue": boolean, "IncludeTableAlterOperations": boolean, "IncludeTransactionDetails": boolean, "MessageFormat": "string", "MessageMaxBytes": number, "NoHexPrefix": boolean, "PartitionIncludeSchemaTable": boolean, "SaslPassword": "string", "SaslUsername": "string", "SecurityProtocol": "string", "SslCaCertificateArn": "string", "SslClientCertificateArn": "string", "SslClientKeyArn": "string", "SslClientKeyPassword": "string", "Topic": "string" }, "KinesisSettings": { "IncludeControlDetails": boolean, "IncludeNullAndEmpty": boolean, "IncludePartitionValue": boolean, "IncludeTableAlterOperations": boolean, "IncludeTransactionDetails": boolean, "MessageFormat": "string", "NoHexPrefix": boolean, "PartitionIncludeSchemaTable": boolean, "ServiceAccessRoleArn": "string", "StreamArn": "string" }, "KmsKeyId": "string", "MicrosoftSQLServerSettings": { "BcpPacketSize": number, "ControlTablesFileGroup": "string", "DatabaseName": "string", "Password": "string", "Port": number, "QuerySingleAlwaysOnNode": boolean, "ReadBackupOnly": boolean, "SafeguardPolicy": "string", "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "UseBcpFullLoad": boolean, "Username": "string", "UseThirdPartyBackupDevice": boolean }, "MongoDbSettings": { "AuthMechanism": "string", "AuthSource": "string", "AuthType": "string", "DatabaseName": "string", "DocsToInvestigate": "string", "ExtractDocId": "string", "KmsKeyId": "string", "NestingLevel": "string", "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "Username": "string" }, "MySQLSettings": { "AfterConnectScript": "string", "CleanSourceMetadataOnMismatch": boolean, "DatabaseName": "string", "EventsPollInterval": number, "MaxFileSize": number, "ParallelLoadThreads": number, "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "ServerTimezone": "string", "TargetDbType": "string", "Username": "string" }, "NeptuneSettings": { "ErrorRetryDuration": number, "IamAuthEnabled": boolean, "MaxFileSize": number, "MaxRetryCount": number, "S3BucketFolder": "string", "S3BucketName": "string", "ServiceAccessRoleArn": "string" }, "OracleSettings": { "AccessAlternateDirectly": boolean, "AdditionalArchivedLogDestId": number, "AddSupplementalLogging": boolean, "AllowSelectNestedTables": boolean, "ArchivedLogDestId": number, "ArchivedLogsOnly": boolean, "AsmPassword": "string", "AsmServer": "string", "AsmUser": "string", "CharLengthSemantics": "string", "DatabaseName": "string", "DirectPathNoLog": boolean, "DirectPathParallelLoad": boolean, "EnableHomogenousTablespace": boolean, "ExtraArchivedLogDestIds": [ number ], "FailTasksOnLobTruncation": boolean, "NumberDatatypeScale": number, "OraclePathPrefix": "string", "ParallelAsmReadThreads": number, "Password": "string", "Port": number, "ReadAheadBlocks": number, "ReadTableSpaceName": boolean, "ReplacePathPrefix": boolean, "RetryInterval": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerOracleAsmAccessRoleArn": "string", "SecretsManagerOracleAsmSecretId": "string", "SecretsManagerSecretId": "string", "SecurityDbEncryption": "string", "SecurityDbEncryptionName": "string", "ServerName": "string", "SpatialDataOptionToGeoJsonFunctionName": "string", "StandbyDelayTime": number, "UseAlternateFolderForOnline": boolean, "UseBFile": boolean, "UseDirectPathFullLoad": boolean, "UseLogminerReader": boolean, "UsePathPrefix": "string", "Username": "string" }, "Port": number, "PostgreSQLSettings": { "AfterConnectScript": "string", "CaptureDdls": boolean, "DatabaseName": "string", "DdlArtifactsSchema": "string", "ExecuteTimeout": number, "FailTasksOnLobTruncation": boolean, "HeartbeatEnable": boolean, "HeartbeatFrequency": number, "HeartbeatSchema": "string", "MaxFileSize": number, "Password": "string", "PluginName": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "SlotName": "string", "Username": "string" }, "RedisSettings": { "AuthPassword": "string", "AuthType": "string", "AuthUserName": "string", "Port": number, "ServerName": "string", "SslCaCertificateArn": "string", "SslSecurityProtocol": "string" }, "RedshiftSettings": { "AcceptAnyDate": boolean, "AfterConnectScript": "string", "BucketFolder": "string", "BucketName": "string", "CaseSensitiveNames": boolean, "CompUpdate": boolean, "ConnectionTimeout": number, "DatabaseName": "string", "DateFormat": "string", "EmptyAsNull": boolean, "EncryptionMode": "string", "ExplicitIds": boolean, "FileTransferUploadStreams": number, "LoadTimeout": number, "MaxFileSize": number, "Password": "string", "Port": number, "RemoveQuotes": boolean, "ReplaceChars": "string", "ReplaceInvalidChars": "string", "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "ServerSideEncryptionKmsKeyId": "string", "ServiceAccessRoleArn": "string", "TimeFormat": "string", "TrimBlanks": boolean, "TruncateColumns": boolean, "Username": "string", "WriteBufferSize": number }, "S3Settings": { "AddColumnName": boolean, "BucketFolder": "string", "BucketName": "string", "CannedAclForObjects": "string", "CdcInsertsAndUpdates": boolean, "CdcInsertsOnly": boolean, "CdcMaxBatchInterval": number, "CdcMinFileSize": number, "CdcPath": "string", "CompressionType": "string", "CsvDelimiter": "string", "CsvNoSupValue": "string", "CsvNullValue": "string", "CsvRowDelimiter": "string", "DataFormat": "string", "DataPageSize": number, "DatePartitionDelimiter": "string", "DatePartitionEnabled": boolean, "DatePartitionSequence": "string", "DictPageSizeLimit": number, "EnableStatistics": boolean, "EncodingType": "string", "EncryptionMode": "string", "ExternalTableDefinition": "string", "IgnoreHeaderRows": number, "IncludeOpForFullLoad": boolean, "MaxFileSize": number, "ParquetTimestampInMillisecond": boolean, "ParquetVersion": "string", "PreserveTransactions": boolean, "Rfc4180": boolean, "RowGroupLength": number, "ServerSideEncryptionKmsKeyId": "string", "ServiceAccessRoleArn": "string", "TimestampColumnName": "string", "UseCsvNoSupValue": boolean }, "ServerName": "string", "ServiceAccessRoleArn": "string", "SslMode": "string", "Status": "string", "SybaseSettings": { "DatabaseName": "string", "Password": "string", "Port": number, "SecretsManagerAccessRoleArn": "string", "SecretsManagerSecretId": "string", "ServerName": "string", "Username": "string" }, "Username": "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.

Endpoint

The modified endpoint.

Type: Endpoint object

Errors

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

AccessDeniedFault

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

HTTP Status Code: 400

InvalidResourceStateFault

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

HTTP Status Code: 400

KMSKeyNotAccessibleFault

Amazon DMS cannot access the Amazon KMS key.

HTTP Status Code: 400

ResourceAlreadyExistsFault

The resource you are attempting to create already exists.

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ModifyEndpoint.

Sample Request

POST / HTTP/1.1 Host: dms.<region>.<domain> x-amz-Date: <Date> Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=contenttype;date;host;user- agent;x-amz-date;x-amz-target;x-amzn- requestid,Signature=<Signature> User-Agent: <UserAgentString> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Connection: Keep-Alive X-Amz-Target: AmazonDMSv20160101.ModifyEndpoint { "EndpointArn":"arn:aws:dms:us-east-1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", "EndpointIdentifier":"", "EndpointType":"target", "EngineName":"", "Username":"", "Password":"", "ServerName":"", "Port":0, "DatabaseName":"", "ExtraConnectionAttributes":"" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: <RequestId> Content-Type: application/x-amz-json-1.1 Content-Length: <PayloadSizeBytes> Date: <Date> { "Endpoint":{ "Username":"username", "Status":"active", "EndpointArn":"arn:aws:dms:us-east- 1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM", "ServerName":"apurvap-source.cxln7iyxx1lo.us-west- 2.rds.amazonaws.com", "EndpointType":"TARGET", "KmsKeyId":"arn:aws:kms:us-east-1:123456789012:key/4dc17316-5543- 4ded-b1e3-d53a7cfb411d", "ExtraConnectionAttributes":"parallelLoadThreads=1", "EngineName":"mysql", "EndpointIdentifier":"test-endpoint-1", "Port":3306 } }

See Also

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