Skip to content

Notification

Source code in docs_src/capo_budgets/types/notification.py
class Notification(TypedDict, closed=True):
    notification_type: "capo_budgets.types.notification_type.NotificationType"
    """<p>Specifies whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much that you're forecasted to spend (<code>FORECASTED</code>).</p>"""
    comparison_operator: "capo_budgets.types.comparison_operator.ComparisonOperator"
    """<p>The comparison that's used for this notification.</p>"""
    threshold: "capo_budgets.types.notification_threshold.NotificationThreshold"
    """<p>The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.</p>"""
    threshold_type: NotRequired["capo_budgets.types.threshold_type.ThresholdType"]
    """<p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a <code>PERCENTAGE</code> threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.</p>"""
    notification_state: NotRequired[
        "capo_budgets.types.notification_state.NotificationState"
    ]
    """<p>Specifies whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you passed the set threshold for the budget.</p>"""

comparison_operator instance-attribute

comparison_operator: ComparisonOperator

The comparison that's used for this notification.

notification_state instance-attribute

notification_state: NotRequired[NotificationState]

Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.

notification_type instance-attribute

notification_type: NotificationType

Specifies whether the notification is for how much you have spent (ACTUAL) or for how much that you're forecasted to spend (FORECASTED).

threshold instance-attribute

The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.

threshold_type instance-attribute

threshold_type: NotRequired[ThresholdType]

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.