Struct CanaryRunStatus 

#[non_exhaustive]
pub struct CanaryRunStatus {
    pub state: Option<CanaryRunState>,
    pub state_reason: Option<String>,
    pub state_reason_code: Option<CanaryRunStateReasonCode>,
    pub test_result: Option<CanaryRunTestResult>,
}

This structure contains the status information about a canary run.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

state: Option<CanaryRunState>

The current state of the run.

state_reason: Option<String>

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

state_reason_code: Option<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.

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.

test_result: Option<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.

Implementations

impl CanaryRunStatus

pub fn state(&self) -> Option<&CanaryRunState>

The current state of the run.

pub fn state_reason(&self) -> Option<&str>

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

pub fn state_reason_code(&self) -> Option<&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.

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.

pub fn test_result(&self) -> Option<&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.

impl CanaryRunStatus

pub fn builder() -> CanaryRunStatusBuilder

Creates a new builder-style object to manufacture CanaryRunStatus.

Trait Implementations

impl Clone for CanaryRunStatus

fn clone(&self) -> CanaryRunStatus

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CanaryRunStatus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CanaryRunStatus

fn eq(&self, other: &CanaryRunStatus) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CanaryRunStatus