AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . budgets ]

describe-budget

Description

Describes a budget.

Warning

The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits , see the Examples section.

See also: AWS API Documentation

Synopsis

  describe-budget
--account-id <value>
--budget-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--account-id (string)

The accountId that is associated with the budget that you want a description of.

--budget-name (string)

The name of the budget that you want a description of.

--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.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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"
           ]
       }
   }
}

Output

Budget -> (structure)

The description of the budget.

BudgetName -> (string)

The name of a budget. The name must be unique within an account. The : and \ characters, and the "/action/" substring, aren't allowed in BudgetName .

BudgetLimit -> (structure)

The total amount of cost, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage that you want to track with your budget.

BudgetLimit is required for cost or usage budgets, but optional for RI or Savings Plans utilization or coverage budgets. RI and Savings Plans utilization or coverage budgets default to 100 . This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't use BudgetLimit with PlannedBudgetLimits for CreateBudget and UpdateBudget actions.

Amount -> (string)

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

Unit -> (string)

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

PlannedBudgetLimits -> (map)

A map containing multiple BudgetLimit , including current or future limits.

PlannedBudgetLimits is available for cost or usage budget and supports both monthly and quarterly TimeUnit .

For monthly budgets, provide 12 months of PlannedBudgetLimits values. This must start from the current month and include the next 11 months. The key is the start of the month, UTC in epoch seconds.

For quarterly budgets, provide four quarters of PlannedBudgetLimits value entries in standard calendar quarter increments. This must start from the current quarter and include the next three quarters. The key is the start of the quarter, UTC in epoch seconds.

If the planned budget expires before 12 months for monthly or four quarters for quarterly, provide the PlannedBudgetLimits values only for the remaining periods.

If the budget begins at a date in the future, provide PlannedBudgetLimits values from the start date of the budget.

After all of the BudgetLimit values in PlannedBudgetLimits are used, the budget continues to use the last limit as the BudgetLimit . At that point, the planned budget provides the same experience as a fixed budget.

DescribeBudget and DescribeBudgets response along with PlannedBudgetLimits also contain BudgetLimit representing the current month or quarter limit present in PlannedBudgetLimits . This only applies to budgets that are created with PlannedBudgetLimits . Budgets that are created without PlannedBudgetLimits only contain BudgetLimit . They don't contain PlannedBudgetLimits .

key -> (string)

A generic string.

value -> (structure)

The amount of cost or usage that's measured for a budget.

Cost example: A Spend for 3 USD of costs has the following parameters:
  • An Amount of 3
  • A Unit of USD
Usage example: A Spend for 3 GB of S3 usage has the following parameters:
  • An Amount of 3
  • A Unit of GB

Amount -> (string)

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

Unit -> (string)

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

CostFilters -> (map)

The cost filters, such as Region , Service , LinkedAccount , Tag , or CostCategory , that are applied to a budget.

Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:

  • Amazon EC2
  • Amazon Redshift
  • Amazon Relational Database Service
  • Amazon ElastiCache
  • Amazon OpenSearch Service

key -> (string)

A generic string.

value -> (list)

(string)

CostTypes -> (structure)

The types of costs that are included in this COST budget.

USAGE , RI_UTILIZATION , RI_COVERAGE , SAVINGS_PLANS_UTILIZATION , and SAVINGS_PLANS_COVERAGE budgets do not have CostTypes .

IncludeTax -> (boolean)

Specifies whether a budget includes taxes.

The default value is true .

IncludeSubscription -> (boolean)

Specifies whether a budget includes subscriptions.

The default value is true .

UseBlended -> (boolean)

Specifies whether a budget uses a blended rate.

The default value is false .

IncludeRefund -> (boolean)

Specifies whether a budget includes refunds.

The default value is true .

IncludeCredit -> (boolean)

Specifies whether a budget includes credits.

The default value is true .

IncludeUpfront -> (boolean)

Specifies whether a budget includes upfront RI costs.

The default value is true .

IncludeRecurring -> (boolean)

Specifies whether a budget includes recurring fees such as monthly RI fees.

The default value is true .

IncludeOtherSubscription -> (boolean)

Specifies whether a budget includes non-RI subscription costs.

The default value is true .

IncludeSupport -> (boolean)

Specifies whether a budget includes support subscription fees.

The default value is true .

IncludeDiscount -> (boolean)

Specifies whether a budget includes discounts.

The default value is true .

UseAmortized -> (boolean)

Specifies whether a budget uses the amortized rate.

The default value is false .

TimeUnit -> (string)

The length of time until a budget resets the actual and forecasted spend.

TimePeriod -> (structure)

The period of time that's covered by a budget. You setthe start date and end date. The start date must come before the end date. The end date must come before 06/15/87 00:00 UTC .

If you create your budget and don't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY , and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC . If you chose MONTHLY , Amazon Web Services set your start date to 01/01/18 00:00 UTC . If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

You can change either date with the UpdateBudget operation.

After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.

Start -> (timestamp)

The start date for a budget. If you created your budget and didn't specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY , and didn't set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC . If you chose MONTHLY , Amazon Web Services set your start date to 01/01/18 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

You can change your start date with the UpdateBudget operation.

End -> (timestamp)

The end date for a budget. If you didn't specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC . The defaults are the same for the Billing and Cost Management console and the API.

After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

CalculatedSpend -> (structure)

The actual and forecasted cost or usage that the budget tracks.

ActualSpend -> (structure)

The amount of cost, usage, RI units, or Savings Plans units that you used.

Amount -> (string)

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

Unit -> (string)

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

ForecastedSpend -> (structure)

The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.

Amount -> (string)

The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.

Unit -> (string)

The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.

BudgetType -> (string)

Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.

LastUpdatedTime -> (timestamp)

The last time that you updated this budget.

AutoAdjustData -> (structure)

The parameters that determine the budget amount for an auto-adjusting budget.

AutoAdjustType -> (string)

The string that defines whether your budget auto-adjusts based on historical or forecasted data.

HistoricalOptions -> (structure)

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

BudgetAdjustmentPeriod -> (integer)

The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:

  • For the DAILY granularity, the maximum value is 60 .
  • For the MONTHLY granularity, the maximum value is 12 .
  • For the QUARTERLY granularity, the maximum value is 4 .
  • For the ANNUALLY granularity, the maximum value is 1 .

LookBackAvailablePeriods -> (integer)

The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit . If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.

For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3 .

You can’t set your own LookBackAvailablePeriods . The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.

LastAutoAdjustTime -> (timestamp)

The last time that your budget was auto-adjusted.