Skip to content

GetTelemetryRuleOutput

Source code in docs_src/capo_observabilityadmin/types/get_telemetry_rule_output.py
class GetTelemetryRuleOutput(TypedDict, closed=True):
    rule_name: NotRequired["capo_observabilityadmin.types.rule_name.RuleName"]
    """<p> The name of the telemetry rule. </p>"""
    rule_arn: NotRequired["capo_observabilityadmin.types.resource_arn.ResourceArn"]
    """<p> The Amazon Resource Name (ARN) of the telemetry rule. </p>"""
    created_time_stamp: NotRequired["int"]
    """<p> The timestamp when the telemetry rule was created. </p>"""
    last_update_time_stamp: NotRequired["int"]
    """<p> The timestamp when the telemetry rule was last updated. </p>"""
    telemetry_rule: NotRequired[
        "capo_observabilityadmin.types.telemetry_rule.TelemetryRule"
    ]
    """<p> The configuration details of the telemetry rule. </p>"""
    home_region: NotRequired["capo_observabilityadmin.types.region.Region"]
    """<p> The Amazon Web Services Region where the telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present. </p>"""
    is_replicated: NotRequired[
        "capo_observabilityadmin.types.is_replicated.IsReplicated"
    ]
    """<p> Indicates whether this telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region. </p>"""
    region_statuses: NotRequired[
        "capo_observabilityadmin.types.region_statuses.RegionStatuses"
    ]
    """<p> A list of per-region replication statuses for the telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope. </p>"""

created_time_stamp instance-attribute

created_time_stamp: NotRequired[int]

The timestamp when the telemetry rule was created.

home_region instance-attribute

home_region: NotRequired[Region]

The Amazon Web Services Region where the telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present.

is_replicated instance-attribute

is_replicated: NotRequired[IsReplicated]

Indicates whether this telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region.

last_update_time_stamp instance-attribute

last_update_time_stamp: NotRequired[int]

The timestamp when the telemetry rule was last updated.

region_statuses instance-attribute

region_statuses: NotRequired[RegionStatuses]

A list of per-region replication statuses for the telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope.

rule_arn instance-attribute

rule_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the telemetry rule.

rule_name instance-attribute

rule_name: NotRequired[RuleName]

The name of the telemetry rule.

telemetry_rule instance-attribute

telemetry_rule: NotRequired[TelemetryRule]

The configuration details of the telemetry rule.