Skip to content

RegionStatus

Source code in docs_src/capo_observabilityadmin/types/region_status.py
class RegionStatus(TypedDict, closed=True):
    region: NotRequired["capo_observabilityadmin.types.region.Region"]
    """<p> The Amazon Web Services Region code (for example, <code>eu-west-1</code> or <code>us-west-2</code>) that this status applies to. </p>"""
    status: NotRequired["str"]
    """<p> The status of the operation in this region. For telemetry evaluation, valid values include <code>STARTING</code>, <code>RUNNING</code>, and <code>FAILED_START</code>. For telemetry rules, valid values include <code>PENDING</code>, <code>ACTIVE</code>, and <code>FAILED</code>. </p>"""
    failure_reason: NotRequired["str"]
    """<p> The reason for a failure status in this region. This field is only populated when <code>Status</code> indicates a failure. </p>"""
    rule_arn: NotRequired["capo_observabilityadmin.types.resource_arn.ResourceArn"]
    """<p> The Amazon Resource Name (ARN) of the telemetry rule in this spoke region. This field is only present for telemetry rule region statuses and is populated when the rule has been successfully created in the spoke region (status is <code>ACTIVE</code>). </p>"""

failure_reason instance-attribute

failure_reason: NotRequired[str]

The reason for a failure status in this region. This field is only populated when Status indicates a failure.

region instance-attribute

region: NotRequired[Region]

The Amazon Web Services Region code (for example, eu-west-1 or us-west-2) that this status applies to.

rule_arn instance-attribute

rule_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the telemetry rule in this spoke region. This field is only present for telemetry rule region statuses and is populated when the rule has been successfully created in the spoke region (status is ACTIVE).

status instance-attribute

status: NotRequired[str]

The status of the operation in this region. For telemetry evaluation, valid values include STARTING, RUNNING, and FAILED_START. For telemetry rules, valid values include PENDING, ACTIVE, and FAILED.