CanaryRunStatus - Amazon CloudWatch Synthetics

CanaryRunStatus

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: