Skip to content

Start Canary

synthetics_start_canary R Documentation

Use this operation to run a canary that has already been created

Description

Use this operation to run a canary that has already been created. The frequency of the canary runs is determined by the value of the canary's Schedule. To see a canary's schedule, use get_canary.

Usage

synthetics_start_canary(Name)

Arguments

Name

[required] The name of the canary that you want to run. To find canary names, use describe_canaries.

Value

An empty list.

Request syntax

svc$start_canary(
  Name = "string"
)