CanaryStatus - Amazon CloudWatch Synthetics

CanaryStatus

A structure that contains the current state of the canary.

Contents

State

The current state of the canary.

Type: String

Valid Values: CREATING | READY | STARTING | RUNNING | UPDATING | STOPPING | STOPPED | ERROR | DELETING

Required: No

StateReason

If the canary has insufficient permissions to run, this field provides more details.

Type: String

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

Required: No

StateReasonCode

If the canary cannot run or has failed, this field displays the reason.

Type: String

Valid Values: INVALID_PERMISSIONS

Required: No

See Also

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