Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::Synthetics::Types::CanaryRunStatus

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

Overview

This structure contains the status information about a canary run.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#stateString

The current state of the run.

Returns:

  • (String)

520
521
522
523
524
525
526
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 520

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

#state_reasonString

If run of the canary failed, this field contains the reason for the error.

Returns:

  • (String)

520
521
522
523
524
525
526
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 520

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

#state_reason_codeString

If this value is CANARY_FAILURE, an exception occurred in the canary code. If this value is EXECUTION_FAILURE, an exception occurred in CloudWatch Synthetics.

Returns:

  • (String)

520
521
522
523
524
525
526
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 520

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