DeleteDomain
Deletes a Domain and all associated resources.
Request Syntax
DELETE /domain/domainId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainId
-
The id of the Domain to delete
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 200
Content-type: application/json
{
"arn": "string",
"domainId": "string",
"status": "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.
- arn
-
The ARN of the Domain that was requested for deletion
Type: String
Pattern:
arn:aws:health-agent:[a-z0-9-]+:[0-9]{12}:domain/(hai-|dom-)[a-z0-9]+ - domainId
-
The id of the Domain requested for deletion
Type: String
Length Constraints: Minimum length of 20. Maximum length of 25.
Pattern:
(hai-|dom-)[a-z0-9]+ - status
-
Current status of Domain
Type: String
Valid Values:
ACTIVE | DELETING | DELETED
Errors
For information about the errors that are common to all actions, see Common Errors.
- ResourceNotFoundException
-
This error is thrown when the requested resource is not found.
HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
