CanaryRunStatus

This structure contains the status information about a canary run.

State

The current state of the run.

Type: String

Valid Values: RUNNING | PASSED | FAILED

Required: No

StateReason

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

StateReasonCode

If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

Type: String

Valid Values: CANARY_FAILURE | EXECUTION_FAILURE

Required: No

TestResult

Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

Type: String

Valid Values: PASSED | FAILED | UNKNOWN

Required: No

CanaryRunStatus

Contents

See Also