**Esta documentação é somente para a versão 1 da AWS CLI.**
Anunciamos o próximo fim do suporte para a AWS CLI versão 1. É recomendável migrar para a AWS CLI versão 2. Para saber as datas e receber detalhes e informações adicionais sobre como migrar, consulte o [anúncio](https://aws.amazon.com/blogs/developer/cli-v1-maintenance-mode-announcement/). Para obter a documentação relacionada à AWS CLI versão 2, consulte o [Guia do usuário da versão 2](https://docs.aws.amazon.com/cli/latest/userguide/).
# AWS Budgets Exemplos do usando a AWS CLI
Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface com o AWS Budgets.
*Ações* são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar perfis de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.
Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.
**Topics**
+ [Ações](#actions)
## Ações
### `create-budget`
O código de exemplo a seguir mostra como usar `create-budget`.
**AWS CLI**
**Para criar um orçamento de custo e uso**
O comando `create-budget` a seguir cria um orçamento de custo e uso.
```
aws budgets create-budget \
--account-id {{111122223333}} \
--budget {{file://budget.json}} \
--notifications-with-subscribers {{file://notifications-with-subscribers.json}}
```
Conteúdo de `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"
}
```
Conteúdo de `notifications-with-subscribers.json`:
```
[
{
"Notification": {
"ComparisonOperator": "GREATER_THAN",
"NotificationType": "ACTUAL",
"Threshold": 80,
"ThresholdType": "PERCENTAGE"
},
"Subscribers": [
{
"Address": "example@example.com",
"SubscriptionType": "EMAIL"
}
]
}
]
```
+ Para ver detalhes da API, consulte [CreateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-budget.html) na *Referência de comandos da AWS CLI*.
### `create-notification`
O código de exemplo a seguir mostra como usar `create-notification`.
**AWS CLI**
**Para criar uma notificação para o orçamento de custo e uso especificado**
Este exemplo cria uma notificação para o orçamento de custo e uso especificado.
Comando:
```
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}}
```
+ Para ver detalhes da API, consulte [CreateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-notification.html) na *Referência de comandos da AWS CLI*.
### `create-subscriber`
O código de exemplo a seguir mostra como usar `create-subscriber`.
**AWS CLI**
**Para criar um assinante para uma notificação associada a um orçamento de custo e uso**
Este exemplo cria um assinante para a notificação especificada.
Comando:
```
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}}
```
+ Para ver detalhes da API, consulte [CreateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/create-subscriber.html) na *Referência de comandos da AWS CLI*.
### `delete-budget`
O código de exemplo a seguir mostra como usar `delete-budget`.
**AWS CLI**
**Para excluir um orçamento de custo e uso**
Este exemplo exclui o orçamento de custo e uso especificado.
Comando:
```
aws budgets delete-budget --account-id {{111122223333}} --budget-name {{"Example Budget"}}
```
+ Para ver detalhes da API, consulte [DeleteBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-budget.html) na *Referência de comandos da AWS CLI*.
### `delete-notification`
O código de exemplo a seguir mostra como usar `delete-notification`.
**AWS CLI**
**Para excluir uma notificação de um orçamento**
Este exemplo exclui a notificação especificada do orçamento especificado.
Comando:
```
aws budgets delete-notification --account-id {{111122223333}} --budget-name {{"Example Budget"}} --notification {{NotificationType=ACTUAL,ComparisonOperator=GREATER_THAN,Threshold=80,ThresholdType=PERCENTAGE}}
```
+ Para ver detalhes da API, consulte [DeleteNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-notification.html) na *Referência de comandos da AWS CLI*.
### `delete-subscriber`
O código de exemplo a seguir mostra como usar `delete-subscriber`.
**AWS CLI**
**Para excluir um assinante de uma notificação**
Este exemplo exclui o assinante especificado da notificação especificada.
Comando:
```
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}}
```
+ Para ver detalhes da API, consulte [DeleteSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/delete-subscriber.html) na *Referência de comandos da AWS CLI*.
### `describe-budget`
O código de exemplo a seguir mostra como usar `describe-budget`.
**AWS CLI**
**Para recuperar um orçamento associado a uma conta**
Este exemplo recupera o orçamento de custo e uso especificado.
Comando:
```
aws budgets describe-budget --account-id {{111122223333}} --budget-name {{"Example Budget"}}
```
Resultado:
```
{
"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"
]
}
}
}
```
+ Para ver detalhes da API, consulte [DescribeBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budget.html) na *Referência de comandos da AWS CLI*.
### `describe-budgets`
O código de exemplo a seguir mostra como usar `describe-budgets`.
**AWS CLI**
**Para recuperar os orçamentos associados a uma conta**
Este exemplo recupera os orçamentos de custo e uso de uma conta.
Comando:
```
aws budgets describe-budgets --account-id {{111122223333}} --max-results {{20}}
```
Resultado:
```
{
"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"
]
}
}
]
}
```
+ Para ver detalhes da API, consulte [DescribeBudgets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-budgets.html) na *Referência de comandos da AWS CLI*.
### `describe-notifications-for-budget`
O código de exemplo a seguir mostra como usar `describe-notifications-for-budget`.
**AWS CLI**
**Para recuperar as notificações de um orçamento**
Este exemplo recupera as notificações de um orçamento de custo e uso.
Comando:
```
aws budgets describe-notifications-for-budget --account-id {{111122223333}} --budget-name {{"Example Budget"}} --max-results {{5}}
```
Resultado:
```
{
"Notifications": [
{
"Threshold": 80.0,
"ComparisonOperator": "GREATER_THAN",
"NotificationType": "ACTUAL"
}
]
}
```
+ Para ver detalhes da API, consulte [DescribeNotificationsForBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-notifications-for-budget.html) na *Referência de comandos da AWS CLI*.
### `describe-subscribers-for-notification`
O código de exemplo a seguir mostra como usar `describe-subscribers-for-notification`.
**AWS CLI**
**Para recuperar os assinantes de uma notificação de orçamento**
Este exemplo recupera os assinantes de uma notificação de orçamento de custo e uso.
Comando:
```
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}}
```
Resultado:
```
{
"Subscribers": [
{
"SubscriptionType": "EMAIL",
"Address": "example2@example.com"
},
{
"SubscriptionType": "EMAIL",
"Address": "example@example.com"
}
]
}
```
+ Para ver detalhes da API, consulte [DescribeSubscribersForNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/describe-subscribers-for-notification.html) na *Referência de comandos da AWS CLI*.
### `update-budget`
O código de exemplo a seguir mostra como usar `update-budget`.
**AWS CLI**
**Para substituir um orçamento por um orçamento de custo e uso**
Este exemplo substitui um orçamento de custo e uso por um novo orçamento.
Comando:
```
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"
}
```
+ Para ver detalhes da API, consulte [UpdateBudget](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-budget.html) na *Referência de comandos da AWS CLI*.
### `update-notification`
O código de exemplo a seguir mostra como usar `update-notification`.
**AWS CLI**
**Para substituir uma notificação por um orçamento de custo e uso**
Este exemplo substitui uma notificação de 80% para um orçamento de custo e uso por uma notificação de 90%.
Comando:
```
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}}
```
+ Para ver detalhes da API, consulte [UpdateNotification](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-notification.html) na *Referência de comandos da AWS CLI*.
### `update-subscriber`
O código de exemplo a seguir mostra como usar `update-subscriber`.
**AWS CLI**
**Para substituir um assinante por um orçamento de custo e uso**
Este exemplo substitui o assinante por um orçamento de custo e uso.
Comando:
```
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}}
```
+ Para ver detalhes da API, consulte [UpdateSubscriber](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/budgets/update-subscriber.html) na *Referência de comandos da AWS CLI*.