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.
Describes the history for DAILY
, MONTHLY
, and QUARTERLY
budgets. Budget history isn't available for ANNUAL
budgets.
See also: AWS API Documentation
describe-budget-performance-history
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: BudgetPerformanceHistory
describe-budget-performance-history
--account-id <value>
--budget-name <value>
[--time-period <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <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>]
--account-id
(string)
The account ID of the user. It's a 12-digit number.
--budget-name
(string)
A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed.
--time-period
(structure)
Retrieves how often the budget went into an
ALARM
state for the specified time period.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 to01/24/18 00:00 UTC
. If you choseMONTHLY
, Amazon Web Services set your start date to01/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.
Shorthand Syntax:
Start=timestamp,End=timestamp
JSON Syntax:
{
"Start": timestamp,
"End": timestamp
}
--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.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command's output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command's output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
--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.
--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.
--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.
BudgetPerformanceHistory -> (structure)
The history of how often the budget has gone into an
ALARM
state.For
DAILY
budgets, the history saves the state of the budget for the last 60 days. ForMONTHLY
budgets, the history saves the state of the budget for the current month plus the last 12 months. ForQUARTERLY
budgets, the history saves the state of the budget for the last four quarters.BudgetName -> (string)
A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed.BudgetType -> (string)
The type of a budget. It must be one of the following types:
COST
,USAGE
,RI_UTILIZATION
,RI_COVERAGE
,SAVINGS_PLANS_UTILIZATION
, orSAVINGS_PLANS_COVERAGE
.CostFilters -> (map)
The history of the cost filters for a budget during the specified time period.
key -> (string)
A generic string.value -> (list)
(string)CostTypes -> (structure)
The history of the cost types for a budget during the specified time period.
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 time unit of the budget, such as MONTHLY or QUARTERLY.BudgetedAndActualAmountsList -> (list)
A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.
(structure)
The amount of cost or usage that you created the budget for, compared to your actual costs or usage.
BudgetedAmount -> (structure)
The amount of cost or usage that you created the budget for.
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.ActualAmount -> (structure)
Your actual costs or usage for a budget period.
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.TimePeriod -> (structure)
The time period that's covered by this budget comparison.
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 to01/24/18 00:00 UTC
. If you choseMONTHLY
, Amazon Web Services set your start date to01/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.
NextToken -> (string)
A generic string.