DeleteCanary - Amazon CloudWatch Synthetics


Permanently deletes the specified canary.

If you specify DeleteLambda to true, CloudWatch Synthetics also deletes the Lambda functions and layers that are used by the canary.

Other resources used and created by the canary are not automatically deleted. After you delete a canary that you do not intend to use again, you should also delete the following:

  • The CloudWatch alarms created for this canary. These alarms have a name of Synthetics-SharpDrop-Alarm-MyCanaryName .

  • Amazon S3 objects and buckets, such as the canary's artifact location.

  • IAM roles created for the canary. If they were created in the console, these roles have the name role/service-role/CloudWatchSyntheticsRole-MyCanaryName .

  • CloudWatch Logs log groups created for the canary. These logs groups have the name /aws/lambda/cwsyn-MyCanaryName .

Before you delete a canary, you might want to use GetCanary to display the information about this canary. Make note of the information returned by this operation so that you can delete these resources after you delete the canary.

Request Syntax

DELETE /canary/name?deleteLambda=DeleteLambda HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


Specifies whether to also delete the Lambda functions and layers used by this canary. The default is false.

Type: Boolean


The name of the canary that you want to delete. To find the names of your canaries, use DescribeCanaries.

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

Pattern: ^[0-9a-z_\-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200

Response Elements

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


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


A conflicting operation is already in progress.

HTTP Status Code: 409


An unknown internal error occurred.

HTTP Status Code: 500


One of the specified resources was not found.

HTTP Status Code: 404


A parameter could not be validated.

HTTP Status Code: 400

See Also

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