Skip to content

CanaryStatus

Source code in docs_src/capo_synthetics/types/canary_status.py 
13
14
15
16
17
18
19
20
21
class CanaryStatus(TypedDict, closed=True):
    state: NotRequired["capo_synthetics.types.canary_state.CanaryState"]
    """<p>The current state of the canary.</p>"""
    state_reason: NotRequired["capo_synthetics.types.string.String"]
    """<p>If the canary creation or update failed, this field provides details on the failure.</p>"""
    state_reason_code: NotRequired[
        "capo_synthetics.types.canary_state_reason_code.CanaryStateReasonCode"
    ]
    """<p>If the canary creation or update failed, this field displays the reason code.</p>"""

state instance-attribute 

state: NotRequired[CanaryState]

The current state of the canary.

state_reason instance-attribute 

state_reason: NotRequired[String]

If the canary creation or update failed, this field provides details on the failure.

state_reason_code instance-attribute 

state_reason_code: NotRequired[CanaryStateReasonCode]

If the canary creation or update failed, this field displays the reason code.