Table Of Contents

Feedback

User Guide

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

[ aws . budgets ]

describe-budgets

Description

Lists the budgets associated with an account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-budgets
--account-id <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 budgets that you want descriptions of.

--max-results (integer)

Optional integer. Specifies the maximum number of results to return in response.

--next-token (string)

The pagination token that indicates the next set of results 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.

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

Budgets -> (list)

A list of budgets.

(structure)

Represents the output of the create-budget operation. The content consists of the detailed metadata and data file information, and the current status of the budget .

The ARN pattern for a budget is: arn:aws:budgetservice::AccountId:budget/budgetName

BudgetName -> (string)

The name of a budget. Unique within accounts. : and \ characters are not allowed in the BudgetName .

BudgetLimit -> (structure)

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

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

Amount -> (string)

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

Unit -> (string)

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

CostFilters -> (map)

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

key -> (string)

A generic String.

value -> (list)

(string)

A generic String.

CostTypes -> (structure)

The types of costs included in this budget.

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 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 covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 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 update-budget 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 (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 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 update-budget 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 update-budget operation.

CalculatedSpend -> (structure)

The actual and forecasted cost or usage being tracked by a budget.

ActualSpend -> (structure)

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

Amount -> (string)

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

Unit -> (string)

The unit of measurement 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 associated with a budget forecast, actual spend, or budget threshold.

Unit -> (string)

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

BudgetType -> (string)

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

NextToken -> (string)

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