# AWS Budgets examples using AWS CLI
The following code examples show you how to perform actions and implement common scenarios by using the AWS Command Line Interface with AWS Budgets.
*Actions* are code excerpts from larger programs and must be run in context. While actions show you how to call individual service functions, you can see actions in context in their related scenarios.
Each example includes a link to the complete source code, where you can find instructions on how to set up and run the code in context.
**Topics**
+ [Actions](#actions)
## Actions
### `create-budget`
The following code example shows how to use `create-budget`.
**AWS CLI**
**To create a Cost and Usage budget**
The following `create-budget` command creates a Cost and Usage budget.
```
aws budgets create-budget \
--account-id 111122223333 \
--budget file://budget.json \
--notifications-with-subscribers file://notifications-with-subscribers.json
```
Contents of `budget.json`:
```
{
"BudgetLimit": {
"Amount": "100",
"Unit": "USD"
},
"BudgetName": "Example Tag Budget",
"BudgetType": "COST",
"CostFilters": {
"TagKeyValue": [
"user:Key$value1",
"user:Key$value2"
]
},
"CostTypes": {
"IncludeCredit": true,
"IncludeDiscount": true,
"IncludeOtherSubscription": true,
"IncludeRecurring": true,
"IncludeRefund": true,
"IncludeSubscription": true,
"IncludeSupport": true,
"IncludeTax": true,
"IncludeUpfront": true,
"UseBlended": false
},
"TimePeriod": {
"Start": 1477958399,
"End": 3706473600
},
"TimeUnit": "MONTHLY"
}
```
Contents of `notifications-with-subscribers.json`:
```
[
{
"Notification": {
"ComparisonOperator": "GREATER_THAN",
"NotificationType": "ACTUAL",
"Threshold": 80,
"ThresholdType": "PERCENTAGE"
},
"Subscribers": [
{
"Address": "example@example.com",
"SubscriptionType": "EMAIL"
}
]
}
]
```
+ For API details, see [CreateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-budget.html) in *AWS CLI Command Reference*.
### `create-notification`
The following code example shows how to use `create-notification`.
**AWS CLI**
**To create a notification for the specified Cost and Usage budget**
This example creates a notification for the specified Cost and Usage budget.
Command:
```
aws budgets create-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com
```
+ For API details, see [CreateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-notification.html) in *AWS CLI Command Reference*.
### `create-subscriber`
The following code example shows how to use `create-subscriber`.
**AWS CLI**
**To create a subscriber for a notification associated with a Cost and Usage budget**
This example creates a subscriber for the specified notification.
Command:
```
aws budgets create-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com
```
+ For API details, see [CreateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-subscriber.html) in *AWS CLI Command Reference*.
### `delete-budget`
The following code example shows how to use `delete-budget`.
**AWS CLI**
**To delete a Cost and Usage budget**
This example deletes the specified Cost and Usage budget.
Command:
```
aws budgets delete-budget --account-id 111122223333 --budget-name "Example Budget"
```
+ For API details, see [DeleteBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-budget.html) in *AWS CLI Command Reference*.
### `delete-notification`
The following code example shows how to use `delete-notification`.
**AWS CLI**
**To delete a notification from a budget**
This example deletes the specified notification from the specified budget.
Command:
```
aws budgets delete-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE
```
+ For API details, see [DeleteNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-notification.html) in *AWS CLI Command Reference*.
### `delete-subscriber`
The following code example shows how to use `delete-subscriber`.
**AWS CLI**
**To delete a subscriber from a notification**
This example deletes the specified subscriber from the specified notification.
Command:
```
aws budgets delete-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --subscriber SubscriptionType=EMAIL,Address=example@example.com
```
+ For API details, see [DeleteSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-subscriber.html) in *AWS CLI Command Reference*.
### `describe-budget`
The following code example shows how to use `describe-budget`.
**AWS CLI**
**To retrieve a budget associated with an account**
This example retrieves the specified Cost and Usage budget.
Command:
```
aws budgets describe-budget --account-id 111122223333 --budget-name "Example Budget"
```
Output:
```
{
"Budget": {
"CalculatedSpend": {
"ForecastedSpend": {
"Amount": "2641.54800000000022919266484677791595458984375",
"Unit": "USD"
},
"ActualSpend": {
"Amount": "604.4560000000000172803993336856365203857421875",
"Unit": "USD"
}
},
"BudgetType": "COST",
"BudgetLimit": {
"Amount": "100",
"Unit": "USD"
},
"BudgetName": "Example Budget",
"CostTypes": {
"IncludeOtherSubscription": true,
"IncludeUpfront": true,
"IncludeRefund": true,
"UseBlended": false,
"IncludeDiscount": true,
"UseAmortized": false,
"IncludeTax": true,
"IncludeCredit": true,
"IncludeSupport": true,
"IncludeRecurring": true,
"IncludeSubscription": true
},
"TimeUnit": "MONTHLY",
"TimePeriod": {
"Start": 1477958399.0,
"End": 3706473600.0
},
"CostFilters": {
"AZ": [
"us-east-1"
]
}
}
}
```
+ For API details, see [DescribeBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budget.html) in *AWS CLI Command Reference*.
### `describe-budgets`
The following code example shows how to use `describe-budgets`.
**AWS CLI**
**To retrieve the budgets associated with an account**
This example retrieves the Cost and Usage budgets for an account.
Command:
```
aws budgets describe-budgets --account-id 111122223333 --max-results 20
```
Output:
```
{
"Budgets": [
{
"CalculatedSpend": {
"ForecastedSpend": {
"Amount": "2641.54800000000022919266484677791595458984375",
"Unit": "USD"
},
"ActualSpend": {
"Amount": "604.4560000000000172803993336856365203857421875",
"Unit": "USD"
}
},
"BudgetType": "COST",
"BudgetLimit": {
"Amount": "100",
"Unit": "USD"
},
"BudgetName": "Example Budget",
"CostTypes": {
"IncludeOtherSubscription": true,
"IncludeUpfront": true,
"IncludeRefund": true,
"UseBlended": false,
"IncludeDiscount": true,
"UseAmortized": false,
"IncludeTax": true,
"IncludeCredit": true,
"IncludeSupport": true,
"IncludeRecurring": true,
"IncludeSubscription": true
},
"TimeUnit": "MONTHLY",
"TimePeriod": {
"Start": 1477958399.0,
"End": 3706473600.0
},
"CostFilters": {
"AZ": [
"us-east-1"
]
}
}
]
}
```
+ For API details, see [DescribeBudgets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budgets.html) in *AWS CLI Command Reference*.
### `describe-notifications-for-budget`
The following code example shows how to use `describe-notifications-for-budget`.
**AWS CLI**
**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"
}
]
}
```
+ For API details, see [DescribeNotificationsForBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-notifications-for-budget.html) in *AWS CLI Command Reference*.
### `describe-subscribers-for-notification`
The following code example shows how to use `describe-subscribers-for-notification`.
**AWS CLI**
**To retrieve the subscribers for a budget notification**
This example retrieves the subscribers for a Cost and Usage budget notification.
Command:
```
aws budgets describe-subscribers-for-notification --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --max-results 5
```
Output:
```
{
"Subscribers": [
{
"SubscriptionType": "EMAIL",
"Address": "example2@example.com"
},
{
"SubscriptionType": "EMAIL",
"Address": "example@example.com"
}
]
}
```
+ For API details, see [DescribeSubscribersForNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-subscribers-for-notification.html) in *AWS CLI Command Reference*.
### `update-budget`
The following code example shows how to use `update-budget`.
**AWS CLI**
**To replace a budget for a Cost and Usage budget**
This example replaces a Cost and Usage budget with a new budget.
Command:
```
aws budgets update-budget --account-id 111122223333 --new-budget file://new-budget.json
```
new-budget.json:
```
{
"BudgetLimit": {
"Amount": "100",
"Unit": "USD"
},
"BudgetName": "Example Budget",
"BudgetType": "COST",
"CostFilters": {
"AZ" : [ "us-east-1" ]
},
"CostTypes": {
"IncludeCredit": false,
"IncludeDiscount": true,
"IncludeOtherSubscription": true,
"IncludeRecurring": true,
"IncludeRefund": true,
"IncludeSubscription": true,
"IncludeSupport": true,
"IncludeTax": true,
"IncludeUpfront": true,
"UseBlended": false,
"UseAmortized": true
},
"TimePeriod": {
"Start": 1477958399,
"End": 3706473600
},
"TimeUnit": "MONTHLY"
}
```
+ For API details, see [UpdateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-budget.html) in *AWS CLI Command Reference*.
### `update-notification`
The following code example shows how to use `update-notification`.
**AWS CLI**
**To replace a notification for a Cost and Usage budget**
This example replaces an 80% notification for a Cost and Usage budget with a 90% notification.
Command:
```
aws budgets update-notification --account-id 111122223333 --budget-name "Example Budget" --old-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --new-notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=90,ThresholdType=PERCENTAGE
```
+ For API details, see [UpdateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-notification.html) in *AWS CLI Command Reference*.
### `update-subscriber`
The following code example shows how to use `update-subscriber`.
**AWS CLI**
**To replace a subscriber for a Cost and Usage budget**
This example replaces the subscriber for a Cost and Usage budget.
Command:
```
aws budgets update-subscriber --account-id 111122223333 --budget-name "Example Budget" --notification NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE --old-subscriber SubscriptionType=EMAIL,Address=example@example.com --new-subscriber SubscriptionType=EMAIL,Address=example2@example.com
```
+ For API details, see [UpdateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-subscriber.html) in *AWS CLI Command Reference*.