DeleteDataProvider
Deletes the specified data provider.
Note
All migration projects associated with the data provider must be deleted or modified before you can delete the data provider.
Request Syntax
{
"DataProviderIdentifier": "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.
- DataProviderIdentifier
-
The identifier of the data provider to delete.
Type: String
Required: Yes
Response Syntax
{
"DataProvider": {
"DataProviderArn": "string",
"DataProviderCreationTime": "string",
"DataProviderName": "string",
"Description": "string",
"Engine": "string",
"Settings": { ... }
}
}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.
- DataProvider
-
The data provider that was deleted.
Type: DataProvider object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
AWS DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- FailedDependencyFault
-
A dependency threw an exception.
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 DeleteDataProvider.
Sample Request
{
"DataProviderIdentifier": "arn:aws:dms:us-east-1:012345678901:data-provider:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
