start_canary

start_canary(**kwargs)

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 GetCanary.

See also: AWS API Documentation

Request Syntax

response = client.start_canary(
    Name='string'
)
Parameters
Name (string) --

[REQUIRED]

The name of the canary that you want to run. To find canary names, use DescribeCanaries.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • Synthetics.Client.exceptions.InternalServerException
  • Synthetics.Client.exceptions.ValidationException
  • Synthetics.Client.exceptions.ResourceNotFoundException
  • Synthetics.Client.exceptions.ConflictException