Own AWS? Customize your docs with AI search, analytics, and more.

DELETE

/canary/{name}

http://synthetics.{region}.amazonaws.com/canary/{name}

Permanently deletes the specified canary. If you specify <code>DeleteLambda</code> to <code>true</code>, 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: <ul> <li> The CloudWatch alarms created for this canary. These alarms have a name of <code>Synthetics-SharpDrop-Alarm-MyCanaryName </code>. </li> <li> Amazon S3 objects and buckets, such as the canary's artifact location. </li> <li> IAM roles created for the canary. If they were created in the console, these roles have the name <code> role/service-role/CloudWatchSyntheticsRole-MyCanaryName </code>. </li> <li> CloudWatch Logs log groups created for the canary. These logs groups have the name <code>/aws/lambda/cwsyn-MyCanaryName </code>. </li> </ul> Before you delete a canary, you might want to use <code>GetCanary</code> 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.

Access Token Required: API Key

Path Parameters

namestringrequired

The name of the canary that you want to delete. To find the names of your canaries, use <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DescribeCanaries.html">DescribeCanaries</a>.

Query Params

deleteLambdaboolean

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://synthetics.{region}.amazonaws.com/canary/{name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

/canary/{name}

http://synthetics.{region}.amazonaws.com/canary/{name}

Access Token Required: API Key

Path Parameters

namestringrequired

Query Params

deleteLambdaboolean

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://synthetics.{region}.amazonaws.com/canary/{name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

/canary/{name}

http://synthetics.{region}.amazonaws.com/canary/{name}

Access Token Required: API Key

Path Parameters

namestringrequired

Query Params

deleteLambdaboolean

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://synthetics.{region}.amazonaws.com/canary/{name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

DELETE

/canary/{name}

http://synthetics.{region}.amazonaws.com/canary/{name}

Access Token Required: API Key

Path Parameters

namestringrequired

Query Params

deleteLambdaboolean

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request DELETE \
2     --url 'http://synthetics.{region}.amazonaws.com/canary/{name}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}