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

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-synthetics/types.rb

Overview

A structure that contains the current state of the canary.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ String

The current state of the canary.

Returns:

  • (String) 


636
637
638
639
640
641
642
 
# File 'lib/aws-sdk-synthetics/types.rb', line 636

class CanaryStatus < Struct.new(
  :state,
  :state_reason,
  :state_reason_code)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason ⇒ String

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

Returns:

  • (String) 


636
637
638
639
640
641
642
 
# File 'lib/aws-sdk-synthetics/types.rb', line 636

class CanaryStatus < Struct.new(
  :state,
  :state_reason,
  :state_reason_code)
  SENSITIVE = []
  include Aws::Structure
end

#state_reason_code ⇒ String

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

Returns:

  • (String) 


636
637
638
639
640
641
642
 
# File 'lib/aws-sdk-synthetics/types.rb', line 636

class CanaryStatus < Struct.new(
  :state,
  :state_reason,
  :state_reason_code)
  SENSITIVE = []
  include Aws::Structure
end