Skip to content

CreateAlertInput

Source code in docs_src/capo_cloudwatchomni/types/create_alert_input.py
class CreateAlertInput(TypedDict, closed=True):
    space_id: "capo_cloudwatchomni.types.space_id.SpaceId"
    """The unique ID of the space to create the alert in."""
    profile_id: "capo_cloudwatchomni.types.profile_id.ProfileId"
    """The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf."""
    name: "str"
    """Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the {@link AlertId}, so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert."""
    description: NotRequired["str"]
    """An optional description of the alert."""
    rule: "capo_cloudwatchomni.types.rule.Rule"
    """The rule that defines how the alert is evaluated."""
    notifications_enabled: NotRequired["bool"]
    """Whether actions (notifications) are enabled for this alert. Defaults to true when omitted."""
    tags: NotRequired["capo_cloudwatchomni.types.tag_map.TagMap"]
    """The tags to associate with the alert."""
    notification_rules: NotRequired[
        "capo_cloudwatchomni.types.notification_rule_list.NotificationRuleList"
    ]
    """The notification rules that determine when and where notifications are sent."""
    client_token: NotRequired["str"]
    """Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate."""

client_token instance-attribute

client_token: NotRequired[str]

Idempotency token for safe retries. Retrying with the same token within the idempotency window returns the original alert instead of creating a duplicate.

description instance-attribute

description: NotRequired[str]

An optional description of the alert.

name instance-attribute

name: str

Alert name, for display. Max 256 (the AlarmName budget). Not the alert's identity: the backend mints a separate uuid as the {@link AlertId}, so the name need not be unique within a space and addressing an alert never depends on it. UpdateAlert accepts a new name to rename the alert.

notification_rules instance-attribute

notification_rules: NotRequired[NotificationRuleList]

The notification rules that determine when and where notifications are sent.

notifications_enabled instance-attribute

notifications_enabled: NotRequired[bool]

Whether actions (notifications) are enabled for this alert. Defaults to true when omitted.

profile_id instance-attribute

profile_id: ProfileId

The ID of the access profile the alert uses to evaluate its query and execute notifications. The caller supplies it: there is no managed alert profile, and the service does not pick one on the caller's behalf.

rule instance-attribute

rule: Rule

The rule that defines how the alert is evaluated.

space_id instance-attribute

space_id: SpaceId

The unique ID of the space to create the alert in.

tags instance-attribute

tags: NotRequired[TagMap]

The tags to associate with the alert.