Budgets.Client.describe_budget(**kwargs)¶Describes a budget.
Warning
The Request Syntax section shows the BudgetLimit syntax. For PlannedBudgetLimits , see the Examples section.
See also: AWS API Documentation
Request Syntax
response = client.describe_budget(
AccountId='string',
BudgetName='string'
)
[REQUIRED]
The accountId that is associated with the budget that you want a description of.
[REQUIRED]
The name of the budget that you want a description of.
dict
Response Syntax
{
'Budget': {
'BudgetName': 'string',
'BudgetLimit': {
'Amount': 'string',
'Unit': 'string'
},
'PlannedBudgetLimits': {
'string': {
'Amount': 'string',
'Unit': 'string'
}
},
'CostFilters': {
'string': [
'string',
]
},
'CostTypes': {
'IncludeTax': True|False,
'IncludeSubscription': True|False,
'UseBlended': True|False,
'IncludeRefund': True|False,
'IncludeCredit': True|False,
'IncludeUpfront': True|False,
'IncludeRecurring': True|False,
'IncludeOtherSubscription': True|False,
'IncludeSupport': True|False,
'IncludeDiscount': True|False,
'UseAmortized': True|False
},
'TimeUnit': 'DAILY'|'MONTHLY'|'QUARTERLY'|'ANNUALLY',
'TimePeriod': {
'Start': datetime(2015, 1, 1),
'End': datetime(2015, 1, 1)
},
'CalculatedSpend': {
'ActualSpend': {
'Amount': 'string',
'Unit': 'string'
},
'ForecastedSpend': {
'Amount': 'string',
'Unit': 'string'
}
},
'BudgetType': 'USAGE'|'COST'|'RI_UTILIZATION'|'RI_COVERAGE'|'SAVINGS_PLANS_UTILIZATION'|'SAVINGS_PLANS_COVERAGE',
'LastUpdatedTime': datetime(2015, 1, 1),
'AutoAdjustData': {
'AutoAdjustType': 'HISTORICAL'|'FORECAST',
'HistoricalOptions': {
'BudgetAdjustmentPeriod': 123,
'LookBackAvailablePeriods': 123
},
'LastAutoAdjustTime': datetime(2015, 1, 1)
}
}
}
Response Structure
(dict) --
Response of DescribeBudget
Budget (dict) --
The description of the budget.
BudgetName (string) --
The name of a budget. The name must be unique within an account. The : and \ characters aren't allowed in BudgetName .
BudgetLimit (dict) --
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.
BudgetLimitis 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 to100. This is the only valid value for RI or Savings Plans utilization or coverage budgets. You can't useBudgetLimitwithPlannedBudgetLimitsforCreateBudgetandUpdateBudgetactions.
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, such as USD or GBP.
PlannedBudgetLimits (dict) --
A map containing multiple BudgetLimit , including current or future limits.
PlannedBudgetLimitsis available for cost or usage budget and supports both monthly and quarterlyTimeUnit.
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.
DescribeBudgetandDescribeBudgetsresponse along withPlannedBudgetLimitsalso containBudgetLimitrepresenting the current month or quarter limit present inPlannedBudgetLimits. This only applies to budgets that are created withPlannedBudgetLimits. Budgets that are created withoutPlannedBudgetLimitsonly containBudgetLimit. They don't containPlannedBudgetLimits.
(string) --
A generic string.
(dict) --
The amount of cost or usage that's measured for a budget.
For example, a Spend for 3 GB of S3 usage has the following parameters:
Amount of 3unit of GBAmount (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, such as USD or GBP.
CostFilters (dict) --
The cost filters, such as Region , Service , member account , Tag , or Cost Category , that are applied to a budget.
Amazon Web Services Budgets supports the following services as a Service filter for RI budgets:
(string) --
A generic string.
CostTypes (dict) --
The types of costs that are included in this COST budget.
USAGE,RI_UTILIZATION,RI_COVERAGE,SAVINGS_PLANS_UTILIZATION, andSAVINGS_PLANS_COVERAGEbudgets do not haveCostTypes.
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 length of time until a budget resets the actual and forecasted spend.
TimePeriod (dict) --
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, 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 to 01/24/18 00:00 UTC . If you chose MONTHLY , Amazon Web Services set your start date to 01/01/18 00:00 UTC . 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.
You can change either date with the UpdateBudget operation.
After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers.
Start (datetime) --
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 to 01/24/18 00:00 UTC . If you chose MONTHLY , Amazon Web Services set your start date to 01/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 (datetime) --
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.
CalculatedSpend (dict) --
The actual and forecasted cost or usage that the budget tracks.
ActualSpend (dict) --
The amount of cost, usage, RI units, or Savings Plans units that you used.
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, such as USD or GBP.
ForecastedSpend (dict) --
The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.
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, such as USD or GBP.
BudgetType (string) --
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.
LastUpdatedTime (datetime) --
The last time that you updated this budget.
AutoAdjustData (dict) --
The parameters that determine the budget amount for an auto-adjusting budget.
AutoAdjustType (string) --
The string that defines whether your budget auto-adjusts based on historical or forecasted data.
HistoricalOptions (dict) --
The parameters that define or describe the historical data that your auto-adjusting budget is based on.
BudgetAdjustmentPeriod (integer) --
The number of budget periods included in the moving-average calculation that determines your auto-adjusted budget amount. The maximum value depends on the TimeUnit granularity of the budget:
DAILY granularity, the maximum value is 60 .MONTHLY granularity, the maximum value is 12 .QUARTERLY granularity, the maximum value is 4 .ANNUALLY granularity, the maximum value is 1 .LookBackAvailablePeriods (integer) --
The integer that describes how many budget periods in your BudgetAdjustmentPeriod are included in the calculation of your current BudgetLimit . If the first budget period in your BudgetAdjustmentPeriod has no cost data, then that budget period isn’t included in the average that determines your budget limit.
For example, if you set BudgetAdjustmentPeriod as 4 quarters, but your account had no cost data in the first quarter, then only the last three quarters are included in the calculation. In this scenario, LookBackAvailablePeriods returns 3 .
You can’t set your own LookBackAvailablePeriods . The value is automatically calculated from the BudgetAdjustmentPeriod and your historical cost data.
LastAutoAdjustTime (datetime) --
The last time that your budget was auto-adjusted.
Exceptions
Budgets.Client.exceptions.InternalErrorExceptionBudgets.Client.exceptions.InvalidParameterExceptionBudgets.Client.exceptions.NotFoundExceptionBudgets.Client.exceptions.AccessDeniedExceptionBudgets.Client.exceptions.ThrottlingException