DeleteReplicationConfig
Deletes an Amazon DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an Amazon DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
Request Syntax
{
"ReplicationConfigArn": "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.
- ReplicationConfigArn
-
The replication config to delete.
Type: String
Required: Yes
Response Syntax
{
"ReplicationConfig": {
"ComputeConfig": {
"AvailabilityZone": "string",
"DnsNameServers": "string",
"KmsKeyId": "string",
"MaxCapacityUnits": number,
"MinCapacityUnits": number,
"MultiAZ": boolean,
"PreferredMaintenanceWindow": "string",
"ReplicationSubnetGroupId": "string",
"VpcSecurityGroupIds": [ "string" ]
},
"ReplicationConfigArn": "string",
"ReplicationConfigCreateTime": number,
"ReplicationConfigIdentifier": "string",
"ReplicationConfigUpdateTime": number,
"ReplicationSettings": "string",
"ReplicationType": "string",
"SourceEndpointArn": "string",
"SupplementalSettings": "string",
"TableMappings": "string",
"TargetEndpointArn": "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.
- ReplicationConfig
-
Configuration parameters returned for the Amazon DMS Serverless replication after it is deleted.
Type: ReplicationConfig 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
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteReplicationConfig.
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.DeleteReplicationConfig
{
"ReplicationConfigArn":"arn:aws:dms:us-east-
1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"ReplicationConfig":"{
"ReplicationConfigIdentifier":"test-replication-config",
"ReplicationConfigArn":"arn:aws:dms:us-east-
1:123456789012:replication-config:UX6OL6MHMMJKFFOXE3H7LLJCMEKBDUG4ZV7DRSI",
"SourceEndpointArn":"arn:aws:dms:us-east-
1:123456789012:endpoint:RZZK4EZW5UANC7Y3P4E776WHBE",
"TargetEndpointArn":"arn:aws:dms:us-east-
1:123456789012:endpoint:GVBUJQXJZASXWHTWCLN2WNT57E",
"ReplicationConfigCreateTime":1677683717.524,
"TableMappings":"{\n \"TableMappings\":
[\n
{\n \"Type\": \"Include\",\n \"SourceSchema\": \"/\",
\n \"SourceTable\": \"/ \"\n
}\n
]\n
}\n\n",
"ReplicationTaskSettings":"{\"TargetMetadata\":
{\"TargetSchema\":\"\",\"SupportLobs\":true,\"FullLobMode\":
true,\"LobChunkSize\":64,\"LimitedSizeLobMode\":
false,\"LobMaxSize\":0
},
\"FullLoadSettings\":{
\"FullLoadEnabled\":true,
\"TargetTablePrepMode\":\"DROP_AND_CREATE\",
\"CreatePkAfterFullLoad\":false,
\"StopTaskCachedChangesApplied\":false,
\"StopTaskCachedChangesNotApplied\":false,
\"ResumeEnabled\":false,
\"ResumeMinTableSize\":100000,
\"ResumeOnlyClusteredPKTables\":true,
\"MaxFullLoadSubTasks\":8,
\"TransactionConsistencyTimeout\":600,
\"CommitRate\":10000
},
\"Logging\":{
\"EnableLogging\":false
}
}"
}"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: