Skip to content

Alert

Source code in docs_src/capo_cloudwatchomni/types/alert.py
class Alert(TypedDict, closed=True):
    name: "str"
    """The name of the alert."""
    alert_id: NotRequired["capo_cloudwatchomni.types.alert_id.AlertId"]
    """The stable alert identifier (see {@link AlertId}), minted on create and immutable across updates. Use it (not {@code name}) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id."""
    description: NotRequired["str"]
    """An optional description of the alert."""
    account_id: "capo_cloudwatchomni.types.account_id.AccountId"
    """The AWS account ID that owns the alert."""
    space_id: NotRequired["capo_cloudwatchomni.types.space_id.SpaceId"]
    """The ID of the space the alert belongs to."""
    profile_id: NotRequired["capo_cloudwatchomni.types.profile_id.ProfileId"]
    """The ID of the access profile associated with the alert."""
    rule: "capo_cloudwatchomni.types.rule.Rule"
    """The rule that defines how the alert is evaluated."""
    notification_status: NotRequired[
        "capo_cloudwatchomni.types.notification_status.NotificationStatus"
    ]
    """Whether notifications are enabled."""
    state: NotRequired["capo_cloudwatchomni.types.alert_state_info.AlertStateInfo"]
    """Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on `AlertSummary` instead, where it stays required. Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it. `contributorSummary` is nested inside this member, so it too is absent on CreateAlert."""
    notification_rules: NotRequired[
        "capo_cloudwatchomni.types.notification_rule_list.NotificationRuleList"
    ]
    """The notification rules for the alert."""
    created_at: "datetime.datetime"
    """The timestamp when the alert was created."""
    updated_at: "datetime.datetime"
    """The timestamp when the alert was last updated."""
    alert_arn: "capo_cloudwatchomni.types.arn.Arn"
    """The Amazon Resource Name (ARN) of the alert."""

account_id instance-attribute

account_id: AccountId

The AWS account ID that owns the alert.

alert_arn instance-attribute

alert_arn: Arn

The Amazon Resource Name (ARN) of the alert.

alert_id instance-attribute

alert_id: NotRequired[AlertId]

The stable alert identifier (see {@link AlertId}), minted on create and immutable across updates. Use it (not {@code name}) to address the alert on GetAlert/UpdateAlert/DeleteAlert; it is also the ARN's resource id.

created_at instance-attribute

created_at: datetime

The timestamp when the alert was created.

description instance-attribute

description: NotRequired[str]

An optional description of the alert.

name instance-attribute

name: str

The name of the alert.

notification_rules instance-attribute

notification_rules: NotRequired[NotificationRuleList]

The notification rules for the alert.

notification_status instance-attribute

notification_status: NotRequired[NotificationStatus]

Whether notifications are enabled.

profile_id instance-attribute

profile_id: NotRequired[ProfileId]

The ID of the access profile associated with the alert.

rule instance-attribute

rule: Rule

The rule that defines how the alert is evaluated.

space_id instance-attribute

space_id: NotRequired[SpaceId]

The ID of the space the alert belongs to.

state instance-attribute

state: NotRequired[AlertStateInfo]

Live evaluation state (read-only, system-managed). Populated by GetAlert. ListAlerts reports state on AlertSummary instead, where it stays required. Absent on CreateAlert: a newly created alert has never been evaluated, so any state reported there would be a default rather than an observation. Call GetAlert for live state. Not @required for that reason — GetAlert always populates it. contributorSummary is nested inside this member, so it too is absent on CreateAlert.

updated_at instance-attribute

updated_at: datetime

The timestamp when the alert was last updated.