Module Values.StopCanaryRequestSource

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.

Sourcetype nonrec t = {
  1. name : CanaryName.t;
    (*

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

    *)
}
Sourceval context_ : string
Sourceval make : name:CanaryName.t -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `String of CanaryName.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t