Table Of Contents

Feedback

User Guide

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

[ aws . budgets ]

describe-budget

Description

Describes a budget.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-budget
--account-id <value>
--budget-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <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.

See 'aws help' for descriptions of global parameters.

Output

Budget -> (structure)

The description of the budget.

BudgetName -> (string)

The name of a budget. The name must be unique within accounts. The : and \ characters aren't allowed in BudgetName .

BudgetLimit -> (structure)

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

BudgetLimit is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to 100 , which is the only valid value for RI utilization or coverage budgets.

Amount -> (string)

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

Unit -> (string)

The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.

CostFilters -> (map)

The cost filters, such as service or region, that are applied to a budget.

AWS Budgets supports the following services as a filter for RI budgets:

  • Amazon Elastic Compute Cloud - Compute
  • Amazon Redshift
  • Amazon Relational Database Service
  • Amazon ElastiCache
  • Amazon Elasticsearch Service

key -> (string)

A generic string.

value -> (list)

(string)

A generic string.

CostTypes -> (structure)

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

USAGE , RI_UTILIZATION , and RI_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. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

TimePeriod -> (structure)

The period of time that is covered by a budget. The period has a start date and an 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, AWS 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, AWS set your start date to 01/24/18 00:00 UTC . If you chose MONTHLY , AWS set your start date to 01/01/18 00:00 UTC . If you didn't specify an end date, AWS set your end date to 06/15/87 00:00 UTC . The defaults are the same for the AWS Billing and Cost Management console and the API.

You can change either date with the UpdateBudget operation.

After the end date, AWS deletes the budget and all associated notifications and subscribers.

Start -> (timestamp)

The start date for a budget. If you created your budget and didn't specify a start date, AWS 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, AWS set your start date to 01/24/18 00:00 UTC . If you chose MONTHLY , AWS set your start date to 01/01/18 00:00 UTC . The defaults are the same for the AWS 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, AWS set your end date to 06/15/87 00:00 UTC . The defaults are the same for the AWS Billing and Cost Management console and the API.

After the end date, AWS deletes the budget and all 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, or RI units that you have used.

Amount -> (string)

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

Unit -> (string)

The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.

ForecastedSpend -> (structure)

The amount of cost, usage, or RI units that you are forecasted to use.

Amount -> (string)

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

Unit -> (string)

The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.

BudgetType -> (string)

Whether this budget tracks monetary costs, usage, RI utilization, or RI coverage.

LastUpdatedTime -> (timestamp)

The last time that you updated this budget.