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

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

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

Overview

This structure contains the status information about a canary run.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#stateString

The current state of the run.

Possible values:

  • RUNNING
  • PASSED
  • FAILED

Returns:

  • (String)

    The current state of the run.

#state_reasonString

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

Returns:

  • (String)

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

#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.

Possible values:

  • CANARY_FAILURE
  • EXECUTION_FAILURE

Returns:

  • (String)

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