CanaryStatus - Amazon CloudWatch Synthetics
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

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 creation or update failed, this field provides details on the failure.

Type: String

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

Required: No

StateReasonCode

If the canary creation or update failed, this field displays the reason code.

Type: String

Valid Values: INVALID_PERMISSIONS | CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_FAILED | UPDATE_PENDING | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | ROLLBACK_COMPLETE | ROLLBACK_FAILED | DELETE_IN_PROGRESS | DELETE_FAILED | SYNC_DELETE_IN_PROGRESS

Required: No

See Also

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