synthetics/aws.sdk.kotlin.services.synthetics.model/CanaryRunStatus

CanaryRunStatus

class CanaryRunStatus

This structure contains the status information about a canary run.

Types

Builder

class Builder

Companion

object Companion

Properties

state

val state: CanaryRunState?

The current state of the run.

stateReason

val stateReason: String?

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

stateReasonCode

val stateReasonCode: CanaryRunStateReasonCode?

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.

testResult

val testResult: CanaryRunTestResult?

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.

Functions

copy

inline fun copy(block: CanaryRunStatus.Builder.() -> Unit = {}): CanaryRunStatus

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String