Describe Canaries
synthetics.describe_canaries
ActionAmazon Web Servicesconnection required
Calls the AWS synthetics API (SigV4).
This operation returns a list of the canaries in your account, along with full details about each canary.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- AWS Synthetics
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
max_results Maximum items to return. | number | No | 50 | ≥ 1 | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"max_results": 50
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
Canaries | array | — |
NextToken | string | — |
{
"Canaries": [],
"NextToken": ""
}Related AWS Synthetics nodes
See Describe Canaries run in a workflow.
In a technical demo we add the AWS Synthetics connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.