The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DeleteEndpoint

Deletes the specified endpoint.

Note

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"
      },
      "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",
      "KinesisSettings": { 
         "MessageFormat": "string",
         "ServiceAccessRoleArn": "string",
         "StreamArn": "string"
      },
      "KmsKeyId": "string",
      "MongoDbSettings": { 
         "AuthMechanism": "string",
         "AuthSource": "string",
         "AuthType": "string",
         "DatabaseName": "string",
         "DocsToInvestigate": "string",
         "ExtractDocId": "string",
         "KmsKeyId": "string",
         "NestingLevel": "string",
         "Password": "string",
         "Port": number,
         "ServerName": "string",
         "Username": "string"
      },
      "Port": number,
      "RedshiftSettings": { 
         "AcceptAnyDate": boolean,
         "AfterConnectScript": "string",
         "BucketFolder": "string",
         "BucketName": "string",
         "ConnectionTimeout": number,
         "DatabaseName": "string",
         "DateFormat": "string",
         "EmptyAsNull": boolean,
         "EncryptionMode": "string",
         "FileTransferUploadStreams": number,
         "LoadTimeout": number,
         "MaxFileSize": number,
         "Password": "string",
         "Port": number,
         "RemoveQuotes": boolean,
         "ReplaceChars": "string",
         "ReplaceInvalidChars": "string",
         "ServerName": "string",
         "ServerSideEncryptionKmsKeyId": "string",
         "ServiceAccessRoleArn": "string",
         "TimeFormat": "string",
         "TrimBlanks": boolean,
         "TruncateColumns": boolean,
         "Username": "string",
         "WriteBufferSize": number
      },
      "S3Settings": { 
         "BucketFolder": "string",
         "BucketName": "string",
         "CdcInsertsOnly": boolean,
         "CompressionType": "string",
         "CsvDelimiter": "string",
         "CsvRowDelimiter": "string",
         "DataFormat": "string",
         "DataPageSize": number,
         "DictPageSizeLimit": number,
         "EnableStatistics": boolean,
         "EncodingType": "string",
         "EncryptionMode": "string",
         "ExternalTableDefinition": "string",
         "IncludeOpForFullLoad": boolean,
         "ParquetVersion": "string",
         "RowGroupLength": number,
         "ServerSideEncryptionKmsKeyId": "string",
         "ServiceAccessRoleArn": "string",
         "TimestampColumnName": "string"
      },
      "ServerName": "string",
      "ServiceAccessRoleArn": "string",
      "SslMode": "string",
      "Status": "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 endpoint that was deleted.

Type: Endpoint object

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

Example

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
   }
}