DeleteDataset
Starts deleting a Dataset and the resources that Amazon Connect Health built for it. You can delete a dataset whose status is ACTIVE, CREATE_FAILED, or DELETE_FAILED. The dataset moves to DELETING, and then to DELETED. If the delete fails, the dataset moves to DELETE_FAILED, and you can call DeleteDataset again.
Medical coding jobs that already use the dataset finish. Amazon Connect Health rejects new requests that specify the dataset.
Datasets are in preview release and are subject to change.
Request Syntax
DELETE /domains/domainId/datasets/datasetId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- datasetId
-
The unique identifier of the dataset to delete.
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-z0-9]{1,64}Required: Yes
- domainId
-
The unique identifier of the parent Domain.
Length Constraints: Minimum length of 20. Maximum length of 25.
Pattern:
(hai-|dom-)[a-z0-9]+Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"arn": "string",
"datasetId": "string",
"status": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- arn
-
The Amazon Resource Name (ARN) of the dataset.
Type: String
Pattern:
arn:aws[a-z\-]*:[a-z0-9\-]+:[a-z0-9\-]*:[0-9]{12}:.+ - datasetId
-
The unique identifier of the dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-z0-9]{1,64} - status
-
The status of the dataset. After Amazon Connect Health accepts the request, the status is DELETING.
Type: String
Valid Values:
CREATING | ACTIVE | CREATE_FAILED | DELETING | DELETE_FAILED | DELETED
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
This error is thrown when the client does not supply proper credentials to the API.
HTTP Status Code: 401
- ConflictException
-
This error is thrown when a resource update is no longer valid due to assumptions about initial state changing.
HTTP Status Code: 409
- InternalServerException
-
This error is thrown when a transient error causes our API to fail.
HTTP Status Code: 500
- ResourceNotFoundException
-
This error is thrown when the requested resource is not found.
HTTP Status Code: 404
- ThrottlingException
-
This error is thrown when the client exceeds the allowed request rate.
HTTP Status Code: 429
- ValidationException
-
This error is thrown when the client supplies invalid input to the API.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: