canary_runs

Creates, updates, deletes, gets or lists a canary_runs resource.

Overview

Name	canary_runs
Type	Resource
Id	aws.synthetics.canary_runs

Fields

The following fields are returned by SELECT queries:

get_canary_runs

Name	Datatype	Description
canary_runs	array	An array of structures. Each structure contains the details of one of the retrieved canary runs.
next_token	string	A token that indicates that there is more data available. You can use this token in a subsequent GetCanaryRuns operation to retrieve the next set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_canary_runs	select	name, region		Retrieves a list of runs for a specified canary.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
name	string	The name of the canary that you want to see runs for.
region	string	AWS region (default: us-east-1)

SELECT examples

get_canary_runs

Retrieves a list of runs for a specified canary.

SELECT
canary_runs,
next_token
FROM aws.synthetics.canary_runs
WHERE name = '{{ name }}' -- required
AND region = '{{ region }}' -- required
;