canaries_list_only
Lists canaries in a region or regions, for all properties use canaries
Overview
| Name | canaries_list_only |
| Type | Resource |
| Description | Resource Type definition for AWS::Synthetics::Canary |
| Id | aws.synthetics.canaries_list_only |
Fields
| Name | Datatype | Description |
|---|---|---|
name | string | Name of the canary. |
region | string | AWS region. |
Methods
| Name | Accessible by | Required Params |
|---|---|---|
list_resources | SELECT | region |
SELECT examples
Lists all canaries in a region.
SELECT
region,
name
FROM aws.synthetics.canaries_list_only
WHERE region = 'us-east-1';
Permissions
For permissions required to operate on the canaries_list_only resource, see canaries