You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Synthetics::Types::CanaryStatus

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

A structure that contains the current state of the canary.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ String

The current state of the canary.

Possible values:

  • CREATING
  • READY
  • STARTING
  • RUNNING
  • UPDATING
  • STOPPING
  • STOPPED
  • ERROR
  • DELETING

Returns:

  • (String) —

    The current state of the canary.

#state_reason ⇒ String

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

Returns:

  • (String) —

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

#state_reason_code ⇒ String

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

Possible values:

  • INVALID_PERMISSIONS

Returns:

  • (String) —

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