AWS Cost Explorer Service
Cost Management APIs

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 ARN pattern for a budget:

arn:aws:budgetservice::AccountId:budget/budgetName

Contents

BudgetLimit

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.

Type: Spend object

Required: No

BudgetName

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

Type: String

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

Pattern: [^:\\]+

Required: Yes

BudgetType

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

Type: String

Valid Values: USAGE | COST | RI_UTILIZATION | RI_COVERAGE

Required: Yes

CalculatedSpend

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

Type: CalculatedSpend object

Required: No

CostFilters

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

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: .*

Required: No

CostTypes

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

USAGE, RI_UTILIZATION, and RI_COVERAGE budgets do not have CostTypes.

Type: CostTypes object

Required: No

LastUpdatedTime

The last time that you updated this budget.

Type: Timestamp

Required: No

TimePeriod

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.

Type: TimePeriod object

Required: No

TimeUnit

The length of time until a budget resets the actual and forecasted spend. DAILY is available only for RI_UTILIZATION and RI_COVERAGE budgets.

Type: String

Valid Values: DAILY | MONTHLY | QUARTERLY | ANNUALLY

Required: Yes

See Also

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

On this page: