DeleteEndpoint
Deletes the specified endpoint.
All tasks associated with the endpoint must be deleted before you can delete the endpoint.
Request Syntax
{
"EndpointArn": "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.
- EndpointArn
-
The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.
Type: String
Required: Yes
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,
"PartitionIncludeSchemaTable": boolean,
"Topic": "string"
},
"KinesisSettings": {
"IncludeControlDetails": boolean,
"IncludeNullAndEmpty": boolean,
"IncludePartitionValue": boolean,
"IncludeTableAlterOperations": boolean,
"IncludeTransactionDetails": boolean,
"MessageFormat": "string",
"PartitionIncludeSchemaTable": boolean,
"ServiceAccessRoleArn": "string",
"StreamArn": "string"
},
"KmsKeyId": "string",
"MicrosoftSQLServerSettings": {
"BcpPacketSize": number,
"ControlTablesFileGroup": "string",
"DatabaseName": "string",
"Password": "string",
"Port": number,
"ReadBackupOnly": boolean,
"SafeguardPolicy": "string",
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string",
"ServerName": "string",
"UseBcpFullLoad": boolean,
"Username": "string"
},
"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",
"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,
"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",
"UseAlternateFolderForOnline": boolean,
"UsePathPrefix": "string",
"Username": "string"
},
"Port": number,
"PostgreSQLSettings": {
"AfterConnectScript": "string",
"CaptureDdls": boolean,
"DatabaseName": "string",
"DdlArtifactsSchema": "string",
"ExecuteTimeout": number,
"FailTasksOnLobTruncation": boolean,
"MaxFileSize": number,
"Password": "string",
"Port": number,
"SecretsManagerAccessRoleArn": "string",
"SecretsManagerSecretId": "string",
"ServerName": "string",
"SlotName": "string",
"Username": "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": {
"BucketFolder": "string",
"BucketName": "string",
"CdcInsertsAndUpdates": boolean,
"CdcInsertsOnly": boolean,
"CdcPath": "string",
"CompressionType": "string",
"CsvDelimiter": "string",
"CsvNoSupValue": "string",
"CsvRowDelimiter": "string",
"DataFormat": "string",
"DataPageSize": number,
"DatePartitionDelimiter": "string",
"DatePartitionEnabled": boolean,
"DatePartitionSequence": "string",
"DictPageSizeLimit": number,
"EnableStatistics": boolean,
"EncodingType": "string",
"EncryptionMode": "string",
"ExternalTableDefinition": "string",
"IncludeOpForFullLoad": boolean,
"ParquetTimestampInMillisecond": boolean,
"ParquetVersion": "string",
"PreserveTransactions": 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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteEndpoint.
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.DeleteEndpoint
{
"EndpointArn": "arn:aws:dms:us-east-
1:123456789012:endpoint:RAAR3R22XSH46S3PWLC3NJAWKM"
}
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":"deleting",
"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 AWS SDKs, see the following:
