Budget - AWS Billing and Cost Management

Budget

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

This is the Amazon Resource Name (ARN) pattern for a budget:

arn:aws:budgets::AccountId:budget/budgetName

Contents

BudgetName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: ^(?![^:\\]*/action/|(?i).*<script>.*</script>.*)[^:\\]+$

Required: Yes

BudgetType

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

Type: String

Valid Values: USAGE | COST | RI_UTILIZATION | RI_COVERAGE | SAVINGS_PLANS_UTILIZATION | SAVINGS_PLANS_COVERAGE

Required: Yes

TimeUnit

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

Type: String

Valid Values: DAILY | MONTHLY | QUARTERLY | ANNUALLY

Required: Yes

AutoAdjustData

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

Type: AutoAdjustData object

Required: No

BudgetLimit

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.

Type: Spend object

Required: No

CalculatedSpend

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

Type: CalculatedSpend object

Required: No

CostFilters

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

AWS 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

Type: String to array of strings map

Key Length Constraints: Minimum length of 0. Maximum length of 2147483647.

Key Pattern: .*

Length Constraints: Minimum length of 0. Maximum length of 2147483647.

Pattern: [\S\s]*

Required: No

CostTypes

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.

Type: CostTypes object

Required: No

LastUpdatedTime

The last time that you updated this budget.

Type: Timestamp

Required: No

PlannedBudgetLimits

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.

Type: String to Spend object map

Key Length Constraints: Minimum length of 0. Maximum length of 2147483647.

Key Pattern: .*

Required: No

TimePeriod

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, 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 the associated notifications and subscribers.

Type: TimePeriod object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: