Skip to content

UpdateAlertInput

Source code in docs_src/capo_cloudwatchomni/types/update_alert_input.py
class UpdateAlertInput(TypedDict, closed=True):
    space_id: "capo_cloudwatchomni.types.space_id.SpaceId"
    """The unique ID of the space."""
    alert_id: "capo_cloudwatchomni.types.alert_id.AlertId"
    """The alert to update."""
    profile_id: NotRequired["capo_cloudwatchomni.types.profile_id.ProfileId"]
    """The ID of the access profile associated with the alert."""
    name: NotRequired["str"]
    """A new display name for the alert. Omit to leave the name unchanged (apply-if-present / PATCH). Same constraints as CreateAlert.name; the name is not the alert's identity, so a rename never changes the alertId."""
    description: NotRequired["str"]
    """A new description of the alert. Omit to leave unchanged."""
    rule: NotRequired["capo_cloudwatchomni.types.rule.Rule"]
    """The rule that defines how the alert is evaluated. Omit to leave unchanged. Each sub-block is replaced whole when present: {@code query}, {@code condition}, {@code evaluation} and {@code noData} are applied only when supplied, and within a supplied block an omitted optional member is cleared to unset (null/absent) rather than preserved from the stored alert or defaulted. See {@link AlertCondition} and {@link AlertEvaluation}."""
    notifications_enabled: NotRequired["bool"]
    """Whether actions (notifications) are enabled for this alert. Omitted = leave existing value unchanged."""
    notification_rules: NotRequired[
        "capo_cloudwatchomni.types.notification_rule_list.NotificationRuleList"
    ]
    """Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop)."""

alert_id instance-attribute

alert_id: AlertId

The alert to update.

description instance-attribute

description: NotRequired[str]

A new description of the alert. Omit to leave unchanged.

name instance-attribute

name: NotRequired[str]

A new display name for the alert. Omit to leave the name unchanged (apply-if-present / PATCH). Same constraints as CreateAlert.name; the name is not the alert's identity, so a rename never changes the alertId.

notification_rules instance-attribute

notification_rules: NotRequired[NotificationRuleList]

Replaces the entire notification rule list when present; full-replace, not merge. Omitted = leave existing rules unchanged. An empty list clears all rules (the alert keeps evaluating; only notifications stop).

notifications_enabled instance-attribute

notifications_enabled: NotRequired[bool]

Whether actions (notifications) are enabled for this alert. Omitted = leave existing value unchanged.

profile_id instance-attribute

profile_id: NotRequired[ProfileId]

The ID of the access profile associated with the alert.

rule instance-attribute

rule: NotRequired[Rule]

The rule that defines how the alert is evaluated. Omit to leave unchanged. Each sub-block is replaced whole when present: {@code query}, {@code condition}, {@code evaluation} and {@code noData} are applied only when supplied, and within a supplied block an omitted optional member is cleared to unset (null/absent) rather than preserved from the stored alert or defaulted. See {@link AlertCondition} and {@link AlertEvaluation}.

space_id instance-attribute

space_id: SpaceId

The unique ID of the space.