Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . budgets ]

describe-notifications-for-budget

Description

Lists the notifications that are associated with a budget.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-notifications-for-budget
--account-id <value>
--budget-name <value>
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--account-id (string)

The accountId that is associated with the budget whose notifications you want descriptions of.

--budget-name (string)

The name of the budget whose notifications you want descriptions of.

--max-results (integer)

An optional integer that represents how many entries a paginated response contains. The maximum is 100.

--next-token (string)

The pagination token that you include in your request to indicate the next set of results that you want to retrieve.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve the notifications for a budget

This example retrieves the notifications for a Cost and Usage budget.

Command:

aws budgets describe-notifications-for-budget --account-id 111122223333 --budget-name "Example Budget" --max-results 5

Output:

{
   "Notifications": [
       {
           "Threshold": 80.0,
           "ComparisonOperator": "GREATER_THAN",
           "NotificationType": "ACTUAL"
       }
   ]
}

Output

Notifications -> (list)

A list of notifications that are associated with a budget.

(structure)

A notification that is associated with a budget. A budget can have up to five notifications.

Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.

For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:

  • A notificationType of ACTUAL
  • A thresholdType of PERCENTAGE
  • A comparisonOperator of GREATER_THAN
  • A notification threshold of 80

NotificationType -> (string)

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

ComparisonOperator -> (string)

The comparison that is used for this notification.

Threshold -> (double)

The threshold that is associated with a notification. Thresholds are always a percentage.

ThresholdType -> (string)

The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, AWS 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%, AWS notifies you when you go over 160 dollars.

NotificationState -> (string)

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

NextToken -> (string)

The pagination token in the service response that indicates the next set of results that you can retrieve.