Skip to content
AWS for Query.Farm

aws.synthetics.get_canary_runs

Example SQL Queries

SELECT * FROM
aws.synthetics.get_canary_runs
WHERE
"name" = 'VALUE';

Description

Retrieves a list of runs for a specified canary.

Table Definition

Column NameColumn Data Type
name Required Input Column

The name of the canary that you want to see runs for.

VARCHAR
max_results Input Column

Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

BIGINT
next_token Input Column

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.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
canary_runs

An array of structures. Each structure contains the details of one of the retrieved canary runs.

STRUCT(
    "id" VARCHAR,
    "name" VARCHAR,
    "status" STRUCT(
        "state" VARCHAR,
        "state_reason" VARCHAR,
        "state_reason_code" VARCHAR
    ),
    "timeline" STRUCT(
        "started" TIMESTAMP_S,
        "completed" TIMESTAMP_S
    ),
    "artifact_s3_location" VARCHAR
)[]
Show child fields
canary_runs[]
Show child fields
canary_runs[].artifact_s3_location

The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

canary_runs[].id

A unique ID that identifies this canary run.

canary_runs[].name

The name of the canary.

canary_runs[].status

The status of this run.

Show child fields
canary_runs[].status.state

The current state of the run.

canary_runs[].status.state_reason

If run of the canary failed, this field contains the reason for the error.

canary_runs[].status.state_reason_code

If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

canary_runs[].timeline

A structure that contains the start and end times of this run.

Show child fields
canary_runs[].timeline.completed

The end time of the run.

canary_runs[].timeline.started

The start time of the run.