StopCanary
Stops the canary to prevent all future runs. If the canary is currently running,the run that is in progress completes on its own, publishes metrics, and uploads artifacts, but it is not recorded in Synthetics as a completed run.
You can use StartCanary to start it running again
with the canary’s current schedule at any point in the future.
Request Syntax
POST /canary/name/stop HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.
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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConflictException
-
A conflicting operation is already in progress.
HTTP Status Code: 409
- InternalServerException
-
An unknown internal error occurred.
HTTP Status Code: 500
- ResourceNotFoundException
-
One of the specified resources was not found.
HTTP Status Code: 404
- ValidationException
-
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:
