Skip to content

GetTelemetryEvaluationStatusOutput

Source code in docs_src/capo_observabilityadmin/types/get_telemetry_evaluation_status_output.py
class GetTelemetryEvaluationStatusOutput(TypedDict, closed=True):
    status: NotRequired["capo_observabilityadmin.types.status.Status"]
    """<p> The onboarding status of the telemetry config feature. </p>"""
    failure_reason: NotRequired[
        "capo_observabilityadmin.types.failure_reason.FailureReason"
    ]
    """<p> Describes the reason for the failure status. The field will only be populated if <code>Status</code> is <code>FAILED_START</code> or <code>FAILED_STOP</code>. </p>"""
    home_region: NotRequired["capo_observabilityadmin.types.region.Region"]
    """<p> The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation. The home region is the single management point for all multi-region operations on this account. This field is only present when multi-region telemetry evaluation is active. </p>"""
    region_statuses: NotRequired[
        "capo_observabilityadmin.types.region_statuses.RegionStatuses"
    ]
    """<p> A list of per-region telemetry evaluation statuses. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active. </p>"""

failure_reason instance-attribute

failure_reason: NotRequired[FailureReason]

Describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.

home_region instance-attribute

home_region: NotRequired[Region]

The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation. The home region is the single management point for all multi-region operations on this account. This field is only present when multi-region telemetry evaluation is active.

region_statuses instance-attribute

region_statuses: NotRequired[RegionStatuses]

A list of per-region telemetry evaluation statuses. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active.

status instance-attribute

status: NotRequired[Status]

The onboarding status of the telemetry config feature.