budget_performance_histories

Creates, updates, deletes, gets or lists a budget_performance_histories resource.

Overview

Name	budget_performance_histories
Type	Resource
Id	aws.budgets.budget_performance_histories

Fields

The following fields are returned by SELECT queries:

describe_budget_performance_history

Name	Datatype	Description
billing_view_arn	string	The Amazon Resource Name (ARN) that uniquely identifies a specific billing view. The ARN is used to specify which particular billing view you want to interact with or retrieve information from when making API calls related to Amazon Web Services Billing and Cost Management features. The BillingViewArn can be retrieved by calling the ListBillingViews API. (pattern: <code>^arn:aws[a-z-]*:(billing)::[0-9]{12}:billingview/[a-zA-Z0-9/:_+=.-@]{0,75}[a-zA-Z0-9]$</code>)
budget_name	string	A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed. Budget names are validated for content. Names that contain phone numbers, URLs, or email addresses combined with certain terms may be rejected. (pattern: <code>^(?![^:\]/action/|(?i).<script>.</script>.)[^:\]+$</code>)
budget_type	string	The type of a budget. It must be one of the following types: COST, USAGE, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, or SAVINGS_PLANS_COVERAGE. (USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE)
budgeted_and_actual_amounts_list	array	A list of amounts of cost or usage that you created budgets for, which are compared to your actual costs or usage.
cost_filters	object	The history of the cost filters for a budget during the specified time period.
cost_types	object	The history of the cost types for a budget during the specified time period.
filter_expression	object	Use Expression to filter in various Budgets APIs.
metrics	array	The definition for how the budget data is aggregated.
time_unit	string	The time unit of the budget, such as MONTHLY or QUARTERLY. (DAILY, MONTHLY, QUARTERLY, ANNUALLY, CUSTOM)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_budget_performance_history	select	region		Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_budget_performance_history

Describes the history for DAILY, MONTHLY, and QUARTERLY budgets. Budget history isn't available for ANNUAL budgets.

SELECT
billing_view_arn,
budget_name,
budget_type,
budgeted_and_actual_amounts_list,
cost_filters,
cost_types,
filter_expression,
metrics,
time_unit
FROM aws.budgets.budget_performance_histories
WHERE region = '{{ region }}' -- required
;