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

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

Overview

A structure that contains the current state of the canary.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#stateString

The current state of the canary.

Returns:

  • (String)


494
495
496
497
498
499
500
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 494

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

#state_reasonString

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

Returns:

  • (String)


494
495
496
497
498
499
500
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 494

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

#state_reason_codeString

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

Returns:

  • (String)


494
495
496
497
498
499
500
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 494

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