Skip to content

HealthStatus

Source code in docs_src/capo_bcm_dashboards/types/health_status.py
class HealthStatus(TypedDict, closed=True):
    status_code: "capo_bcm_dashboards.types.health_status_code.HealthStatusCode"
    """<p>The health status code. <code>HEALTHY</code> indicates the scheduled report is configured properly and has all required permissions to execute. <code>UNHEALTHY</code> indicates the scheduled report is unable to deliver the notification to the default Amazon EventBridge EventBus in your account and your action is needed. The reason for the unhealthy state is captured in the health status reasons.</p>"""
    last_refreshed_at: NotRequired[
        "capo_bcm_dashboards.types.generic_time_stamp.GenericTimeStamp"
    ]
    """<p>The timestamp when the health status was last refreshed.</p>"""
    status_reasons: NotRequired[
        "capo_bcm_dashboards.types.status_reason_list.StatusReasonList"
    ]
    """<p>The list of reasons for the current health status. Only present when the status is <code>UNHEALTHY</code>.</p>"""

last_refreshed_at instance-attribute

last_refreshed_at: NotRequired[GenericTimeStamp]

The timestamp when the health status was last refreshed.

status_code instance-attribute

status_code: HealthStatusCode

The health status code. HEALTHY indicates the scheduled report is configured properly and has all required permissions to execute. UNHEALTHY indicates the scheduled report is unable to deliver the notification to the default Amazon EventBridge EventBus in your account and your action is needed. The reason for the unhealthy state is captured in the health status reasons.

status_reasons instance-attribute

status_reasons: NotRequired[StatusReasonList]

The list of reasons for the current health status. Only present when the status is UNHEALTHY.