Stop Canary
| synthetics_stop_canary | R Documentation |
Stops the canary to prevent all future runs¶
Description¶
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 start_canary to start it running again with the canary’s
current schedule at any point in the future.
Usage¶
Arguments¶
Name[required] The name of the canary that you want to stop. To find the names of your canaries, use ListCanaries.
Value¶
An empty list.