Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account
CanaryRunStatus - Amazon CloudWatch Synthetics
ContentsSee Also

CanaryRunStatus

PDF

This structure contains the status information about a canary run.

Contents

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, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

Type: String

Valid Values: CANARY_FAILURE | EXECUTION_FAILURE

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

Previous topic:

CanaryRunConfigOutput

Need help?

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.