2024/05/07 - AWS Budgets - 3 new2 updated api methods
Changes This release adds tag support for budgets and budget actions.
Lists tags associated with a budget or budget action resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
ResourceARN='string'
)
string
[REQUIRED]
The unique identifier for the resource.
dict
Response Syntax
{
'ResourceTags': [
{
'Key': 'string',
'Value': 'string'
},
]
}
Response Structure
(dict) --
ResourceTags (list) --
The tags associated with the resource.
(dict) --
The tag structure that contains a tag key and value.
Key (string) --
The key that's associated with the tag.
Value (string) --
The value that's associated with the tag.
Deletes tags associated with a budget or budget action resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
ResourceARN='string',
ResourceTagKeys=[
'string',
]
)
string
[REQUIRED]
The unique identifier for the resource.
list
[REQUIRED]
The key that's associated with the tag.
(string) --
dict
Response Syntax
{}
Response Structure
(dict) --
Creates tags for a budget or budget action resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
ResourceARN='string',
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The unique identifier for the resource.
list
[REQUIRED]
The tags associated with the resource.
(dict) --
The tag structure that contains a tag key and value.
Key (string) -- [REQUIRED]
The key that's associated with the tag.
Value (string) -- [REQUIRED]
The value that's associated with the tag.
dict
Response Syntax
{}
Response Structure
(dict) --
{'ResourceTags': [{'Key': 'string', 'Value': 'string'}]}
Creates a budget and, if included, notifications and subscribers.
See also: AWS API Documentation
Request Syntax
client.create_budget(
AccountId='string',
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)
}
},
NotificationsWithSubscribers=[
{
'Notification': {
'NotificationType': 'ACTUAL'|'FORECASTED',
'ComparisonOperator': 'GREATER_THAN'|'LESS_THAN'|'EQUAL_TO',
'Threshold': 123.0,
'ThresholdType': 'PERCENTAGE'|'ABSOLUTE_VALUE',
'NotificationState': 'OK'|'ALARM'
},
'Subscribers': [
{
'SubscriptionType': 'SNS'|'EMAIL',
'Address': 'string'
},
]
},
],
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The accountId that is associated with the budget.
dict
[REQUIRED]
The budget object that you want to create.
BudgetName (string) -- [REQUIRED]
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.
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.
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.
Amount (string) -- [REQUIRED]
The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.
Unit (string) -- [REQUIRED]
The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.
PlannedBudgetLimits (dict) --
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.
(string) --
A generic string.
(dict) --
The amount of cost or usage that's measured for a budget.
Cost example: A Spend for 3 USD of costs has the following parameters:
An Amount of 3
A Unit of USD
Usage example: A Spend for 3 GB of S3 usage has the following parameters:
An Amount of 3
A Unit of GB
Amount (string) -- [REQUIRED]
The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.
Unit (string) -- [REQUIRED]
The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.
CostFilters (dict) --
The cost filters, such as Region, Service, LinkedAccount, Tag, or CostCategory, that are applied to a budget.
Amazon Web Services 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
(string) --
A generic string.
(list) --
(string) --
CostTypes (dict) --
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.
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) -- [REQUIRED]
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) -- [REQUIRED]
The amount of cost, usage, RI units, or Savings Plans units that you used.
Amount (string) -- [REQUIRED]
The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.
Unit (string) -- [REQUIRED]
The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.
ForecastedSpend (dict) --
The amount of cost, usage, RI units, or Savings Plans units that you're forecasted to use.
Amount (string) -- [REQUIRED]
The cost or usage amount that's associated with a budget forecast, actual spend, or budget threshold.
Unit (string) -- [REQUIRED]
The unit of measurement that's used for the budget forecast, actual spend, or budget threshold.
BudgetType (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
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:
For the DAILY granularity, the maximum value is 60.
For the MONTHLY granularity, the maximum value is 12.
For the QUARTERLY granularity, the maximum value is 4.
For the 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.
list
A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your CreateBudget call, Amazon Web Services creates the notifications and subscribers for you.
(dict) --
A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.
Notification (dict) -- [REQUIRED]
The notification that's associated with a budget.
NotificationType (string) -- [REQUIRED]
Specifies whether the notification is for how much you have spent ( ACTUAL) or for how much that you're forecasted to spend ( FORECASTED).
ComparisonOperator (string) -- [REQUIRED]
The comparison that's used for this notification.
Threshold (float) -- [REQUIRED]
The threshold that's associated with a notification. Thresholds are always a percentage, and many customers find value being alerted between 50% - 200% of the budgeted amount. The maximum limit for your threshold is 1,000,000% above the budgeted amount.
ThresholdType (string) --
The type of threshold for a notification. For ABSOLUTE_VALUE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over your total cost threshold. For PERCENTAGE thresholds, Amazon Web Services notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a PERCENTAGE threshold of 80%, Amazon Web Services notifies you when you go over 160 dollars.
NotificationState (string) --
Specifies whether this notification is in alarm. If a budget notification is in the ALARM state, you passed the set threshold for the budget.
Subscribers (list) -- [REQUIRED]
A list of subscribers who are subscribed to this notification.
(dict) --
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber has the following parameters:
A subscriptionType of EMAIL
An address of example@example.com
SubscriptionType (string) -- [REQUIRED]
The type of notification that Amazon Web Services sends to a subscriber.
Address (string) -- [REQUIRED]
The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can't contain line breaks.
list
An optional list of tags to associate with the specified budget. Each tag consists of a key and a value, and each key must be unique for the resource.
(dict) --
The tag structure that contains a tag key and value.
Key (string) -- [REQUIRED]
The key that's associated with the tag.
Value (string) -- [REQUIRED]
The value that's associated with the tag.
dict
Response Syntax
{}
Response Structure
(dict) --
Response of CreateBudget
{'ResourceTags': [{'Key': 'string', 'Value': 'string'}]}
Creates a budget action.
See also: AWS API Documentation
Request Syntax
client.create_budget_action(
AccountId='string',
BudgetName='string',
NotificationType='ACTUAL'|'FORECASTED',
ActionType='APPLY_IAM_POLICY'|'APPLY_SCP_POLICY'|'RUN_SSM_DOCUMENTS',
ActionThreshold={
'ActionThresholdValue': 123.0,
'ActionThresholdType': 'PERCENTAGE'|'ABSOLUTE_VALUE'
},
Definition={
'IamActionDefinition': {
'PolicyArn': 'string',
'Roles': [
'string',
],
'Groups': [
'string',
],
'Users': [
'string',
]
},
'ScpActionDefinition': {
'PolicyId': 'string',
'TargetIds': [
'string',
]
},
'SsmActionDefinition': {
'ActionSubType': 'STOP_EC2_INSTANCES'|'STOP_RDS_INSTANCES',
'Region': 'string',
'InstanceIds': [
'string',
]
}
},
ExecutionRoleArn='string',
ApprovalModel='AUTOMATIC'|'MANUAL',
Subscribers=[
{
'SubscriptionType': 'SNS'|'EMAIL',
'Address': 'string'
},
],
ResourceTags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The account ID of the user. It's a 12-digit number.
string
[REQUIRED]
A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed.
string
[REQUIRED]
The type of a notification. It must be ACTUAL or FORECASTED.
string
[REQUIRED]
The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.
dict
[REQUIRED]
The trigger threshold of the action.
ActionThresholdValue (float) -- [REQUIRED]
The threshold of a notification.
ActionThresholdType (string) -- [REQUIRED]
The type of threshold for a notification.
dict
[REQUIRED]
Specifies all of the type-specific parameters.
IamActionDefinition (dict) --
The Identity and Access Management (IAM) action definition details.
PolicyArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the policy to be attached.
Roles (list) --
A list of roles to be attached. There must be at least one role.
(string) --
Groups (list) --
A list of groups to be attached. There must be at least one group.
(string) --
Users (list) --
A list of users to be attached. There must be at least one user.
(string) --
ScpActionDefinition (dict) --
The service control policies (SCPs) action definition details.
PolicyId (string) -- [REQUIRED]
The policy ID attached.
TargetIds (list) -- [REQUIRED]
A list of target IDs.
(string) --
SsmActionDefinition (dict) --
The Amazon Web Services Systems Manager (SSM) action definition details.
ActionSubType (string) -- [REQUIRED]
The action subType.
Region (string) -- [REQUIRED]
The Region to run the SSM document.
InstanceIds (list) -- [REQUIRED]
The EC2 and RDS instance IDs.
(string) --
string
[REQUIRED]
The role passed for action execution and reversion. Roles and actions must be in the same account.
string
[REQUIRED]
This specifies if the action needs manual or automatic approval.
list
[REQUIRED]
A list of subscribers.
(dict) --
The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.
For example, an email subscriber has the following parameters:
A subscriptionType of EMAIL
An address of example@example.com
SubscriptionType (string) -- [REQUIRED]
The type of notification that Amazon Web Services sends to a subscriber.
Address (string) -- [REQUIRED]
The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.
When you create a subscriber, the value of Address can't contain line breaks.
list
An optional list of tags to associate with the specified budget action. Each tag consists of a key and a value, and each key must be unique for the resource.
(dict) --
The tag structure that contains a tag key and value.
Key (string) -- [REQUIRED]
The key that's associated with the tag.
Value (string) -- [REQUIRED]
The value that's associated with the tag.
dict
Response Syntax
{
'AccountId': 'string',
'BudgetName': 'string',
'ActionId': 'string'
}
Response Structure
(dict) --
AccountId (string) --
The account ID of the user. It's a 12-digit number.
BudgetName (string) --
A string that represents the budget name. The ":" and "" characters, and the "/action/" substring, aren't allowed.
ActionId (string) --
A system-generated universally unique identifier (UUID) for the action.