View a markdown version of this page

DeleteHealthCheckSource - Amazon Route 53

DeleteHealthCheckSource

Deletes a health check source. Before you delete a health check source, delete or update any health checks that reference it. Otherwise, the request fails with InvalidInput. The request also fails with InvalidInput if the status of the health check source is CREATE_PENDING or CREATE_IN_PROGRESS. Wait until the status is CREATE_COMPLETED or CREATE_FAILED, and then try again.

Route 53 deletes a health check source asynchronously, and the initial HealthCheckSourceStatus is DELETE_PENDING. Call GetHealthCheckSource to track progress. After the deletion completes, GetHealthCheckSource returns NoSuchHealthCheckSource and the health check source no longer appears in the results of ListHealthCheckSources. If you delete a health check source that is already deleted, the request fails with NoSuchHealthCheckSource.

To use this operation, you must have the route53:DeleteHealthCheckSource permission. You must also have permission to create a service-linked role.

Request Syntax

DELETE /2013-04-01/healthchecksource/HealthCheckSourceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

HealthCheckSourceId

The ID of the health check source that you want to delete.

Length Constraints: Minimum length of 1. Maximum length of 64.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 <?xml version="1.0" encoding="UTF-8"?> <DeleteHealthCheckSourceResponse> <HealthCheckSourceId>string</HealthCheckSourceId> <HealthCheckSourceStatus>string</HealthCheckSourceStatus> </DeleteHealthCheckSourceResponse>

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in XML format by the service.

DeleteHealthCheckSourceResponse

Root level tag for the DeleteHealthCheckSourceResponse parameters.

Required: Yes

HealthCheckSourceId

The ID of the health check source that is being deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

HealthCheckSourceStatus

The status of the health check source after Route 53 accepts the delete request. The value is DELETE_PENDING, or the current status if deletion of the health check source was already in progress.

Type: String

Valid Values: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETED | CREATE_FAILED | DELETE_PENDING | DELETE_IN_PROGRESS | DELETE_COMPLETED | DELETE_FAILED

Errors

For information about the errors that are common to all actions, see Common Error Types.

InvalidInput

The input is not valid.

message

HTTP Status Code: 400

NoSuchHealthCheckSource

No health check source exists with the specified ID. Verify that the ID is correct and that the health check source hasn't been deleted.

HTTP Status Code: 404

PriorRequestNotComplete

If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request). If Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: