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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#state ⇒ String

The current state of the run.

Returns:

  • (String) 


744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 744

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

#state_reason ⇒ String

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

Returns:

  • (String) 


744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 744

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

#state_reason_code ⇒ String

If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

Returns:

  • (String) 


744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 744

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

#test_result ⇒ String

Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

Returns:

  • (String) 


744
745
746
747
748
749
750
751
 
# File 'gems/aws-sdk-synthetics/lib/aws-sdk-synthetics/types.rb', line 744

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