aws-sdk-budgets 1.46.0 → 1.47.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-budgets/client.rb +41 -17
- data/lib/aws-sdk-budgets/client_api.rb +14 -0
- data/lib/aws-sdk-budgets/types.rb +240 -116
- data/lib/aws-sdk-budgets.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b480648ddd45e113aab14f453cffd5faf6b9e1e37d202e9f7b9c3624c2dec2ab
|
4
|
+
data.tar.gz: dbbbc23f4ed5c60e5fb5268fc62496185a545853a7d96630937fbf3fe5a3d031
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 062f023054660e8aa8c2b275a9bed960213bf0d140163115e69ff319987f33004df71cf376e43846ef9bcbe5c5530dfd3924360fd6eb4d45af1bac766633f406
|
7
|
+
data.tar.gz: d7ef0ee9aa3317cf3eabd89457a5120c414e80a36da188e6119eba6e0d54dca29c32f8b656bbe46ab9287938c67e8c43ff6b118bb373f914461fa3be3d55c365
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.47.0 (2022-02-16)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Adds support for auto-adjusting budgets, a new budget method alongside fixed and planned. Auto-adjusting budgets introduces new metadata to configure a budget limit baseline using a historical lookback average or current period forecast.
|
8
|
+
|
4
9
|
1.46.0 (2022-02-03)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.47.0
|
@@ -380,8 +380,8 @@ module Aws::Budgets
|
|
380
380
|
# A notification that you want to associate with a budget. A budget can
|
381
381
|
# have up to five notifications, and each notification can have one SNS
|
382
382
|
# subscriber and up to 10 email subscribers. If you include
|
383
|
-
# notifications and subscribers in your `CreateBudget` call,
|
384
|
-
# the notifications and subscribers for you.
|
383
|
+
# notifications and subscribers in your `CreateBudget` call, Amazon Web
|
384
|
+
# Services creates the notifications and subscribers for you.
|
385
385
|
#
|
386
386
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
387
387
|
#
|
@@ -434,6 +434,14 @@ module Aws::Budgets
|
|
434
434
|
# },
|
435
435
|
# budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
|
436
436
|
# last_updated_time: Time.now,
|
437
|
+
# auto_adjust_data: {
|
438
|
+
# auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
|
439
|
+
# historical_options: {
|
440
|
+
# budget_adjustment_period: 1, # required
|
441
|
+
# look_back_available_periods: 1,
|
442
|
+
# },
|
443
|
+
# last_auto_adjust_time: Time.now,
|
444
|
+
# },
|
437
445
|
# },
|
438
446
|
# notifications_with_subscribers: [
|
439
447
|
# {
|
@@ -464,7 +472,7 @@ module Aws::Budgets
|
|
464
472
|
# Creates a budget action.
|
465
473
|
#
|
466
474
|
# @option params [required, String] :account_id
|
467
|
-
# The account ID of the user. It
|
475
|
+
# The account ID of the user. It's a 12-digit number.
|
468
476
|
#
|
469
477
|
# @option params [required, String] :budget_name
|
470
478
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -559,8 +567,8 @@ module Aws::Budgets
|
|
559
567
|
# create a notification for.
|
560
568
|
#
|
561
569
|
# @option params [required, String] :budget_name
|
562
|
-
# The name of the budget that you want
|
563
|
-
# names must be unique within an account.
|
570
|
+
# The name of the budget that you want Amazon Web Services to notify you
|
571
|
+
# about. Budget names must be unique within an account.
|
564
572
|
#
|
565
573
|
# @option params [required, Types::Notification] :notification
|
566
574
|
# The notification that you want to create.
|
@@ -674,7 +682,7 @@ module Aws::Budgets
|
|
674
682
|
# Deletes a budget action.
|
675
683
|
#
|
676
684
|
# @option params [required, String] :account_id
|
677
|
-
# The account ID of the user. It
|
685
|
+
# The account ID of the user. It's a 12-digit number.
|
678
686
|
#
|
679
687
|
# @option params [required, String] :budget_name
|
680
688
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -877,6 +885,10 @@ module Aws::Budgets
|
|
877
885
|
# resp.budget.calculated_spend.forecasted_spend.unit #=> String
|
878
886
|
# resp.budget.budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE"
|
879
887
|
# resp.budget.last_updated_time #=> Time
|
888
|
+
# resp.budget.auto_adjust_data.auto_adjust_type #=> String, one of "HISTORICAL", "FORECAST"
|
889
|
+
# resp.budget.auto_adjust_data.historical_options.budget_adjustment_period #=> Integer
|
890
|
+
# resp.budget.auto_adjust_data.historical_options.look_back_available_periods #=> Integer
|
891
|
+
# resp.budget.auto_adjust_data.last_auto_adjust_time #=> Time
|
880
892
|
#
|
881
893
|
# @overload describe_budget(params = {})
|
882
894
|
# @param [Hash] params ({})
|
@@ -888,7 +900,7 @@ module Aws::Budgets
|
|
888
900
|
# Describes a budget action detail.
|
889
901
|
#
|
890
902
|
# @option params [required, String] :account_id
|
891
|
-
# The account ID of the user. It
|
903
|
+
# The account ID of the user. It's a 12-digit number.
|
892
904
|
#
|
893
905
|
# @option params [required, String] :budget_name
|
894
906
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -953,7 +965,7 @@ module Aws::Budgets
|
|
953
965
|
# Describes a budget action history detail.
|
954
966
|
#
|
955
967
|
# @option params [required, String] :account_id
|
956
|
-
# The account ID of the user. It
|
968
|
+
# The account ID of the user. It's a 12-digit number.
|
957
969
|
#
|
958
970
|
# @option params [required, String] :budget_name
|
959
971
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -964,7 +976,7 @@ module Aws::Budgets
|
|
964
976
|
# action.
|
965
977
|
#
|
966
978
|
# @option params [Types::TimePeriod] :time_period
|
967
|
-
# The period of time that
|
979
|
+
# The period of time that's covered by a budget. The period has a start
|
968
980
|
# date and an end date. The start date must come before the end date.
|
969
981
|
# There are no restrictions on the end date.
|
970
982
|
#
|
@@ -1041,7 +1053,7 @@ module Aws::Budgets
|
|
1041
1053
|
# Describes all of the budget actions for an account.
|
1042
1054
|
#
|
1043
1055
|
# @option params [required, String] :account_id
|
1044
|
-
# The account ID of the user. It
|
1056
|
+
# The account ID of the user. It's a 12-digit number.
|
1045
1057
|
#
|
1046
1058
|
# @option params [Integer] :max_results
|
1047
1059
|
# An integer that represents how many entries a paginated response
|
@@ -1106,7 +1118,7 @@ module Aws::Budgets
|
|
1106
1118
|
# Describes all of the budget actions for a budget.
|
1107
1119
|
#
|
1108
1120
|
# @option params [required, String] :account_id
|
1109
|
-
# The account ID of the user. It
|
1121
|
+
# The account ID of the user. It's a 12-digit number.
|
1110
1122
|
#
|
1111
1123
|
# @option params [required, String] :budget_name
|
1112
1124
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -1177,7 +1189,7 @@ module Aws::Budgets
|
|
1177
1189
|
# Budget history isn't available for `ANNUAL` budgets.
|
1178
1190
|
#
|
1179
1191
|
# @option params [required, String] :account_id
|
1180
|
-
# The account ID of the user. It
|
1192
|
+
# The account ID of the user. It's a 12-digit number.
|
1181
1193
|
#
|
1182
1194
|
# @option params [required, String] :budget_name
|
1183
1195
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -1317,6 +1329,10 @@ module Aws::Budgets
|
|
1317
1329
|
# resp.budgets[0].calculated_spend.forecasted_spend.unit #=> String
|
1318
1330
|
# resp.budgets[0].budget_type #=> String, one of "USAGE", "COST", "RI_UTILIZATION", "RI_COVERAGE", "SAVINGS_PLANS_UTILIZATION", "SAVINGS_PLANS_COVERAGE"
|
1319
1331
|
# resp.budgets[0].last_updated_time #=> Time
|
1332
|
+
# resp.budgets[0].auto_adjust_data.auto_adjust_type #=> String, one of "HISTORICAL", "FORECAST"
|
1333
|
+
# resp.budgets[0].auto_adjust_data.historical_options.budget_adjustment_period #=> Integer
|
1334
|
+
# resp.budgets[0].auto_adjust_data.historical_options.look_back_available_periods #=> Integer
|
1335
|
+
# resp.budgets[0].auto_adjust_data.last_auto_adjust_time #=> Time
|
1320
1336
|
# resp.next_token #=> String
|
1321
1337
|
#
|
1322
1338
|
# @overload describe_budgets(params = {})
|
@@ -1436,7 +1452,7 @@ module Aws::Budgets
|
|
1436
1452
|
# Executes a budget action.
|
1437
1453
|
#
|
1438
1454
|
# @option params [required, String] :account_id
|
1439
|
-
# The account ID of the user. It
|
1455
|
+
# The account ID of the user. It's a 12-digit number.
|
1440
1456
|
#
|
1441
1457
|
# @option params [required, String] :budget_name
|
1442
1458
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -1481,8 +1497,8 @@ module Aws::Budgets
|
|
1481
1497
|
|
1482
1498
|
# Updates a budget. You can change every part of a budget except for the
|
1483
1499
|
# `budgetName` and the `calculatedSpend`. When you modify a budget, the
|
1484
|
-
# `calculatedSpend` drops to zero until
|
1485
|
-
# for forecasting.
|
1500
|
+
# `calculatedSpend` drops to zero until Amazon Web Services has new
|
1501
|
+
# usage data to use for forecasting.
|
1486
1502
|
#
|
1487
1503
|
# Only one of `BudgetLimit` or `PlannedBudgetLimits` can be present in
|
1488
1504
|
# the syntax at one time. Use the syntax that matches your case. The
|
@@ -1551,6 +1567,14 @@ module Aws::Budgets
|
|
1551
1567
|
# },
|
1552
1568
|
# budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
|
1553
1569
|
# last_updated_time: Time.now,
|
1570
|
+
# auto_adjust_data: {
|
1571
|
+
# auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
|
1572
|
+
# historical_options: {
|
1573
|
+
# budget_adjustment_period: 1, # required
|
1574
|
+
# look_back_available_periods: 1,
|
1575
|
+
# },
|
1576
|
+
# last_auto_adjust_time: Time.now,
|
1577
|
+
# },
|
1554
1578
|
# },
|
1555
1579
|
# })
|
1556
1580
|
#
|
@@ -1564,7 +1588,7 @@ module Aws::Budgets
|
|
1564
1588
|
# Updates a budget action.
|
1565
1589
|
#
|
1566
1590
|
# @option params [required, String] :account_id
|
1567
|
-
# The account ID of the user. It
|
1591
|
+
# The account ID of the user. It's a 12-digit number.
|
1568
1592
|
#
|
1569
1593
|
# @option params [required, String] :budget_name
|
1570
1594
|
# A string that represents the budget name. The ":" and "\\"
|
@@ -1809,7 +1833,7 @@ module Aws::Budgets
|
|
1809
1833
|
params: params,
|
1810
1834
|
config: config)
|
1811
1835
|
context[:gem_name] = 'aws-sdk-budgets'
|
1812
|
-
context[:gem_version] = '1.
|
1836
|
+
context[:gem_version] = '1.47.0'
|
1813
1837
|
Seahorse::Client::Request.new(handlers, context)
|
1814
1838
|
end
|
1815
1839
|
|
@@ -25,7 +25,10 @@ module Aws::Budgets
|
|
25
25
|
ActionThreshold = Shapes::StructureShape.new(name: 'ActionThreshold')
|
26
26
|
ActionType = Shapes::StringShape.new(name: 'ActionType')
|
27
27
|
Actions = Shapes::ListShape.new(name: 'Actions')
|
28
|
+
AdjustmentPeriod = Shapes::IntegerShape.new(name: 'AdjustmentPeriod')
|
28
29
|
ApprovalModel = Shapes::StringShape.new(name: 'ApprovalModel')
|
30
|
+
AutoAdjustData = Shapes::StructureShape.new(name: 'AutoAdjustData')
|
31
|
+
AutoAdjustType = Shapes::StringShape.new(name: 'AutoAdjustType')
|
29
32
|
Budget = Shapes::StructureShape.new(name: 'Budget')
|
30
33
|
BudgetName = Shapes::StringShape.new(name: 'BudgetName')
|
31
34
|
BudgetPerformanceHistory = Shapes::StructureShape.new(name: 'BudgetPerformanceHistory')
|
@@ -84,6 +87,7 @@ module Aws::Budgets
|
|
84
87
|
GenericTimestamp = Shapes::TimestampShape.new(name: 'GenericTimestamp')
|
85
88
|
Group = Shapes::StringShape.new(name: 'Group')
|
86
89
|
Groups = Shapes::ListShape.new(name: 'Groups')
|
90
|
+
HistoricalOptions = Shapes::StructureShape.new(name: 'HistoricalOptions')
|
87
91
|
IamActionDefinition = Shapes::StructureShape.new(name: 'IamActionDefinition')
|
88
92
|
InstanceId = Shapes::StringShape.new(name: 'InstanceId')
|
89
93
|
InstanceIds = Shapes::ListShape.new(name: 'InstanceIds')
|
@@ -167,6 +171,11 @@ module Aws::Budgets
|
|
167
171
|
|
168
172
|
Actions.member = Shapes::ShapeRef.new(shape: Action)
|
169
173
|
|
174
|
+
AutoAdjustData.add_member(:auto_adjust_type, Shapes::ShapeRef.new(shape: AutoAdjustType, required: true, location_name: "AutoAdjustType"))
|
175
|
+
AutoAdjustData.add_member(:historical_options, Shapes::ShapeRef.new(shape: HistoricalOptions, location_name: "HistoricalOptions"))
|
176
|
+
AutoAdjustData.add_member(:last_auto_adjust_time, Shapes::ShapeRef.new(shape: GenericTimestamp, location_name: "LastAutoAdjustTime"))
|
177
|
+
AutoAdjustData.struct_class = Types::AutoAdjustData
|
178
|
+
|
170
179
|
Budget.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, required: true, location_name: "BudgetName"))
|
171
180
|
Budget.add_member(:budget_limit, Shapes::ShapeRef.new(shape: Spend, location_name: "BudgetLimit"))
|
172
181
|
Budget.add_member(:planned_budget_limits, Shapes::ShapeRef.new(shape: PlannedBudgetLimits, location_name: "PlannedBudgetLimits"))
|
@@ -177,6 +186,7 @@ module Aws::Budgets
|
|
177
186
|
Budget.add_member(:calculated_spend, Shapes::ShapeRef.new(shape: CalculatedSpend, location_name: "CalculatedSpend"))
|
178
187
|
Budget.add_member(:budget_type, Shapes::ShapeRef.new(shape: BudgetType, required: true, location_name: "BudgetType"))
|
179
188
|
Budget.add_member(:last_updated_time, Shapes::ShapeRef.new(shape: GenericTimestamp, location_name: "LastUpdatedTime"))
|
189
|
+
Budget.add_member(:auto_adjust_data, Shapes::ShapeRef.new(shape: AutoAdjustData, location_name: "AutoAdjustData"))
|
180
190
|
Budget.struct_class = Types::Budget
|
181
191
|
|
182
192
|
BudgetPerformanceHistory.add_member(:budget_name, Shapes::ShapeRef.new(shape: BudgetName, location_name: "BudgetName"))
|
@@ -405,6 +415,10 @@ module Aws::Budgets
|
|
405
415
|
|
406
416
|
Groups.member = Shapes::ShapeRef.new(shape: Group)
|
407
417
|
|
418
|
+
HistoricalOptions.add_member(:budget_adjustment_period, Shapes::ShapeRef.new(shape: AdjustmentPeriod, required: true, location_name: "BudgetAdjustmentPeriod"))
|
419
|
+
HistoricalOptions.add_member(:look_back_available_periods, Shapes::ShapeRef.new(shape: AdjustmentPeriod, location_name: "LookBackAvailablePeriods"))
|
420
|
+
HistoricalOptions.struct_class = Types::HistoricalOptions
|
421
|
+
|
408
422
|
IamActionDefinition.add_member(:policy_arn, Shapes::ShapeRef.new(shape: PolicyArn, required: true, location_name: "PolicyArn"))
|
409
423
|
IamActionDefinition.add_member(:roles, Shapes::ShapeRef.new(shape: Roles, location_name: "Roles"))
|
410
424
|
IamActionDefinition.add_member(:groups, Shapes::ShapeRef.new(shape: Groups, location_name: "Groups"))
|
@@ -63,7 +63,7 @@ module Aws::Budgets
|
|
63
63
|
# @return [String]
|
64
64
|
#
|
65
65
|
# @!attribute [rw] status
|
66
|
-
# The status of action.
|
66
|
+
# The status of the action.
|
67
67
|
# @return [String]
|
68
68
|
#
|
69
69
|
# @!attribute [rw] subscribers
|
@@ -88,7 +88,7 @@ module Aws::Budgets
|
|
88
88
|
# The historical records for a budget action.
|
89
89
|
#
|
90
90
|
# @!attribute [rw] timestamp
|
91
|
-
# A generic time stamp. In Java, it
|
91
|
+
# A generic time stamp. In Java, it's transformed to a `Date` object.
|
92
92
|
# @return [Time]
|
93
93
|
#
|
94
94
|
# @!attribute [rw] status
|
@@ -97,11 +97,11 @@ module Aws::Budgets
|
|
97
97
|
#
|
98
98
|
# @!attribute [rw] event_type
|
99
99
|
# This distinguishes between whether the events are triggered by the
|
100
|
-
# user or generated by the system.
|
100
|
+
# user or are generated by the system.
|
101
101
|
# @return [String]
|
102
102
|
#
|
103
103
|
# @!attribute [rw] action_history_details
|
104
|
-
# The description of details
|
104
|
+
# The description of the details for the event.
|
105
105
|
# @return [Types::ActionHistoryDetails]
|
106
106
|
#
|
107
107
|
class ActionHistory < Struct.new(
|
@@ -113,7 +113,7 @@ module Aws::Budgets
|
|
113
113
|
include Aws::Structure
|
114
114
|
end
|
115
115
|
|
116
|
-
# The description of details
|
116
|
+
# The description of the details for the event.
|
117
117
|
#
|
118
118
|
# @!attribute [rw] message
|
119
119
|
# A generic string.
|
@@ -155,11 +155,48 @@ module Aws::Budgets
|
|
155
155
|
include Aws::Structure
|
156
156
|
end
|
157
157
|
|
158
|
+
# The parameters that determine the budget amount for an auto-adjusting
|
159
|
+
# budget.
|
160
|
+
#
|
161
|
+
# @note When making an API call, you may pass AutoAdjustData
|
162
|
+
# data as a hash:
|
163
|
+
#
|
164
|
+
# {
|
165
|
+
# auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
|
166
|
+
# historical_options: {
|
167
|
+
# budget_adjustment_period: 1, # required
|
168
|
+
# look_back_available_periods: 1,
|
169
|
+
# },
|
170
|
+
# last_auto_adjust_time: Time.now,
|
171
|
+
# }
|
172
|
+
#
|
173
|
+
# @!attribute [rw] auto_adjust_type
|
174
|
+
# The string that defines whether your budget auto-adjusts based on
|
175
|
+
# historical or forecasted data.
|
176
|
+
# @return [String]
|
177
|
+
#
|
178
|
+
# @!attribute [rw] historical_options
|
179
|
+
# The parameters that define or describe the historical data that your
|
180
|
+
# auto-adjusting budget is based on.
|
181
|
+
# @return [Types::HistoricalOptions]
|
182
|
+
#
|
183
|
+
# @!attribute [rw] last_auto_adjust_time
|
184
|
+
# The last time that your budget was auto-adjusted.
|
185
|
+
# @return [Time]
|
186
|
+
#
|
187
|
+
class AutoAdjustData < Struct.new(
|
188
|
+
:auto_adjust_type,
|
189
|
+
:historical_options,
|
190
|
+
:last_auto_adjust_time)
|
191
|
+
SENSITIVE = []
|
192
|
+
include Aws::Structure
|
193
|
+
end
|
194
|
+
|
158
195
|
# Represents the output of the `CreateBudget` operation. The content
|
159
196
|
# consists of the detailed metadata and data file information, and the
|
160
197
|
# current status of the `budget` object.
|
161
198
|
#
|
162
|
-
# This is the ARN pattern for a budget:
|
199
|
+
# This is the Amazon Resource Name (ARN) pattern for a budget:
|
163
200
|
#
|
164
201
|
# `arn:aws:budgets::AccountId:budget/budgetName`
|
165
202
|
#
|
@@ -211,6 +248,14 @@ module Aws::Budgets
|
|
211
248
|
# },
|
212
249
|
# budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
|
213
250
|
# last_updated_time: Time.now,
|
251
|
+
# auto_adjust_data: {
|
252
|
+
# auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
|
253
|
+
# historical_options: {
|
254
|
+
# budget_adjustment_period: 1, # required
|
255
|
+
# look_back_available_periods: 1,
|
256
|
+
# },
|
257
|
+
# last_auto_adjust_time: Time.now,
|
258
|
+
# },
|
214
259
|
# }
|
215
260
|
#
|
216
261
|
# @!attribute [rw] budget_name
|
@@ -225,8 +270,8 @@ module Aws::Budgets
|
|
225
270
|
#
|
226
271
|
# `BudgetLimit` is required for cost or usage budgets, but optional
|
227
272
|
# for RI or Savings Plans utilization or coverage budgets. RI and
|
228
|
-
# Savings Plans utilization or coverage budgets default to `100
|
229
|
-
#
|
273
|
+
# Savings Plans utilization or coverage budgets default to `100`. This
|
274
|
+
# is the only valid value for RI or Savings Plans utilization or
|
230
275
|
# coverage budgets. You can't use `BudgetLimit` with
|
231
276
|
# `PlannedBudgetLimits` for `CreateBudget` and `UpdateBudget` actions.
|
232
277
|
# @return [Types::Spend]
|
@@ -236,19 +281,20 @@ module Aws::Budgets
|
|
236
281
|
# limits.
|
237
282
|
#
|
238
283
|
# `PlannedBudgetLimits` is available for cost or usage budget and
|
239
|
-
# supports monthly and quarterly `TimeUnit`.
|
284
|
+
# supports both monthly and quarterly `TimeUnit`.
|
240
285
|
#
|
241
286
|
# For monthly budgets, provide 12 months of `PlannedBudgetLimits`
|
242
287
|
# values. This must start from the current month and include the next
|
243
288
|
# 11 months. The `key` is the start of the month, `UTC` in epoch
|
244
289
|
# seconds.
|
245
290
|
#
|
246
|
-
# For quarterly budgets, provide
|
247
|
-
# value entries in standard calendar quarter
|
248
|
-
# start from the current quarter and include the
|
249
|
-
# `key` is the start of the quarter, `UTC` in
|
291
|
+
# For quarterly budgets, provide four quarters of
|
292
|
+
# `PlannedBudgetLimits` value entries in standard calendar quarter
|
293
|
+
# increments. This must start from the current quarter and include the
|
294
|
+
# next three quarters. The `key` is the start of the quarter, `UTC` in
|
295
|
+
# epoch seconds.
|
250
296
|
#
|
251
|
-
# If the planned budget expires before 12 months for monthly or
|
297
|
+
# If the planned budget expires before 12 months for monthly or four
|
252
298
|
# quarters for quarterly, provide the `PlannedBudgetLimits` values
|
253
299
|
# only for the remaining periods.
|
254
300
|
#
|
@@ -261,21 +307,22 @@ module Aws::Budgets
|
|
261
307
|
# experience as a fixed budget.
|
262
308
|
#
|
263
309
|
# `DescribeBudget` and `DescribeBudgets` response along with
|
264
|
-
# `PlannedBudgetLimits`
|
265
|
-
#
|
266
|
-
# This only applies to budgets created with
|
267
|
-
# Budgets created without
|
268
|
-
# `
|
310
|
+
# `PlannedBudgetLimits` also contain `BudgetLimit` representing the
|
311
|
+
# current month or quarter limit present in `PlannedBudgetLimits`.
|
312
|
+
# This only applies to budgets that are created with
|
313
|
+
# `PlannedBudgetLimits`. Budgets that are created without
|
314
|
+
# `PlannedBudgetLimits` only contain `BudgetLimit`. They don't
|
315
|
+
# contain `PlannedBudgetLimits`.
|
269
316
|
# @return [Hash<String,Types::Spend>]
|
270
317
|
#
|
271
318
|
# @!attribute [rw] cost_filters
|
272
|
-
# The cost filters, such as
|
273
|
-
# budget.
|
319
|
+
# The cost filters, such as `Region`, `Service`, `member account`,
|
320
|
+
# `Tag`, or `Cost Category`, that are applied to a budget.
|
274
321
|
#
|
275
|
-
#
|
276
|
-
# budgets:
|
322
|
+
# Amazon Web Services Budgets supports the following services as a
|
323
|
+
# `Service` filter for RI budgets:
|
277
324
|
#
|
278
|
-
# * Amazon
|
325
|
+
# * Amazon EC2
|
279
326
|
#
|
280
327
|
# * Amazon Redshift
|
281
328
|
#
|
@@ -283,7 +330,7 @@ module Aws::Budgets
|
|
283
330
|
#
|
284
331
|
# * Amazon ElastiCache
|
285
332
|
#
|
286
|
-
# * Amazon
|
333
|
+
# * Amazon OpenSearch Service
|
287
334
|
# @return [Hash<String,Array<String>>]
|
288
335
|
#
|
289
336
|
# @!attribute [rw] cost_types
|
@@ -300,24 +347,25 @@ module Aws::Budgets
|
|
300
347
|
# @return [String]
|
301
348
|
#
|
302
349
|
# @!attribute [rw] time_period
|
303
|
-
# The period of time that
|
304
|
-
#
|
305
|
-
#
|
306
|
-
#
|
307
|
-
# If you create your budget and don't specify a start date,
|
308
|
-
# defaults to the start of your chosen time period
|
309
|
-
# QUARTERLY, or ANNUALLY). For example, if you
|
310
|
-
# January 24, 2018, chose `DAILY`, and didn't
|
311
|
-
# set
|
312
|
-
#
|
313
|
-
#
|
314
|
-
#
|
315
|
-
#
|
350
|
+
# The period of time that's covered by a budget. You setthe start
|
351
|
+
# date and end date. The start date must come before the end date. The
|
352
|
+
# end date must come before `06/15/87 00:00 UTC`.
|
353
|
+
#
|
354
|
+
# If you create your budget and don't specify a start date, Amazon
|
355
|
+
# Web Services defaults to the start of your chosen time period
|
356
|
+
# (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you
|
357
|
+
# created your budget on January 24, 2018, chose `DAILY`, and didn't
|
358
|
+
# set a start date, Amazon Web Services set your start date to
|
359
|
+
# `01/24/18 00:00 UTC`. If you chose `MONTHLY`, Amazon Web Services
|
360
|
+
# set your start date to `01/01/18 00:00 UTC`. If you didn't specify
|
361
|
+
# an end date, Amazon Web Services set your end date to `06/15/87
|
362
|
+
# 00:00 UTC`. The defaults are the same for the Billing and Cost
|
363
|
+
# Management console and the API.
|
316
364
|
#
|
317
365
|
# You can change either date with the `UpdateBudget` operation.
|
318
366
|
#
|
319
|
-
# After the end date,
|
320
|
-
# notifications and subscribers.
|
367
|
+
# After the end date, Amazon Web Services deletes the budget and all
|
368
|
+
# the associated notifications and subscribers.
|
321
369
|
# @return [Types::TimePeriod]
|
322
370
|
#
|
323
371
|
# @!attribute [rw] calculated_spend
|
@@ -325,14 +373,19 @@ module Aws::Budgets
|
|
325
373
|
# @return [Types::CalculatedSpend]
|
326
374
|
#
|
327
375
|
# @!attribute [rw] budget_type
|
328
|
-
#
|
329
|
-
# coverage, Savings Plans utilization, or Savings Plans coverage.
|
376
|
+
# Specifies whether this budget tracks costs, usage, RI utilization,
|
377
|
+
# RI coverage, Savings Plans utilization, or Savings Plans coverage.
|
330
378
|
# @return [String]
|
331
379
|
#
|
332
380
|
# @!attribute [rw] last_updated_time
|
333
381
|
# The last time that you updated this budget.
|
334
382
|
# @return [Time]
|
335
383
|
#
|
384
|
+
# @!attribute [rw] auto_adjust_data
|
385
|
+
# The parameters that determine the budget amount for an
|
386
|
+
# auto-adjusting budget.
|
387
|
+
# @return [Types::AutoAdjustData]
|
388
|
+
#
|
336
389
|
class Budget < Struct.new(
|
337
390
|
:budget_name,
|
338
391
|
:budget_limit,
|
@@ -343,7 +396,8 @@ module Aws::Budgets
|
|
343
396
|
:time_period,
|
344
397
|
:calculated_spend,
|
345
398
|
:budget_type,
|
346
|
-
:last_updated_time
|
399
|
+
:last_updated_time,
|
400
|
+
:auto_adjust_data)
|
347
401
|
SENSITIVE = []
|
348
402
|
include Aws::Structure
|
349
403
|
end
|
@@ -379,7 +433,7 @@ module Aws::Budgets
|
|
379
433
|
#
|
380
434
|
# @!attribute [rw] budgeted_and_actual_amounts_list
|
381
435
|
# A list of amounts of cost or usage that you created budgets for,
|
382
|
-
# compared to your actual costs or usage.
|
436
|
+
# which are compared to your actual costs or usage.
|
383
437
|
# @return [Array<Types::BudgetedAndActualAmounts>]
|
384
438
|
#
|
385
439
|
class BudgetPerformanceHistory < Struct.new(
|
@@ -405,7 +459,7 @@ module Aws::Budgets
|
|
405
459
|
# @return [Types::Spend]
|
406
460
|
#
|
407
461
|
# @!attribute [rw] time_period
|
408
|
-
# The time period covered by this budget comparison.
|
462
|
+
# The time period that's covered by this budget comparison.
|
409
463
|
# @return [Types::TimePeriod]
|
410
464
|
#
|
411
465
|
class BudgetedAndActualAmounts < Struct.new(
|
@@ -418,10 +472,10 @@ module Aws::Budgets
|
|
418
472
|
|
419
473
|
# The spend objects that are associated with this budget. The
|
420
474
|
# `actualSpend` tracks how much you've used, cost, usage, RI units, or
|
421
|
-
# Savings Plans units and the `forecastedSpend` tracks how much
|
422
|
-
# predicted to spend based on your historical usage profile.
|
475
|
+
# Savings Plans units and the `forecastedSpend` tracks how much that
|
476
|
+
# you're predicted to spend based on your historical usage profile.
|
423
477
|
#
|
424
|
-
# For example, if it
|
478
|
+
# For example, if it's the 20th of the month and you have spent `50`
|
425
479
|
# dollars on Amazon EC2, your `actualSpend` is `50 USD`, and your
|
426
480
|
# `forecastedSpend` is `75 USD`.
|
427
481
|
#
|
@@ -441,12 +495,12 @@ module Aws::Budgets
|
|
441
495
|
#
|
442
496
|
# @!attribute [rw] actual_spend
|
443
497
|
# The amount of cost, usage, RI units, or Savings Plans units that you
|
444
|
-
#
|
498
|
+
# used.
|
445
499
|
# @return [Types::Spend]
|
446
500
|
#
|
447
501
|
# @!attribute [rw] forecasted_spend
|
448
|
-
# The amount of cost, usage, RI units, or Savings Plans units that
|
449
|
-
#
|
502
|
+
# The amount of cost, usage, RI units, or Savings Plans units that
|
503
|
+
# you're forecasted to use.
|
450
504
|
# @return [Types::Spend]
|
451
505
|
#
|
452
506
|
class CalculatedSpend < Struct.new(
|
@@ -460,7 +514,7 @@ module Aws::Budgets
|
|
460
514
|
# and subscriptions.
|
461
515
|
#
|
462
516
|
# `USAGE`, `RI_UTILIZATION`, `RI_COVERAGE`, `SAVINGS_PLANS_UTILIZATION`,
|
463
|
-
# and `SAVINGS_PLANS_COVERAGE` budgets
|
517
|
+
# and `SAVINGS_PLANS_COVERAGE` budgets don't have `CostTypes`.
|
464
518
|
#
|
465
519
|
# @note When making an API call, you may pass CostTypes
|
466
520
|
# data as a hash:
|
@@ -602,7 +656,7 @@ module Aws::Budgets
|
|
602
656
|
# }
|
603
657
|
#
|
604
658
|
# @!attribute [rw] account_id
|
605
|
-
# The account ID of the user. It
|
659
|
+
# The account ID of the user. It's a 12-digit number.
|
606
660
|
# @return [String]
|
607
661
|
#
|
608
662
|
# @!attribute [rw] budget_name
|
@@ -656,7 +710,7 @@ module Aws::Budgets
|
|
656
710
|
end
|
657
711
|
|
658
712
|
# @!attribute [rw] account_id
|
659
|
-
# The account ID of the user. It
|
713
|
+
# The account ID of the user. It's a 12-digit number.
|
660
714
|
# @return [String]
|
661
715
|
#
|
662
716
|
# @!attribute [rw] budget_name
|
@@ -729,6 +783,14 @@ module Aws::Budgets
|
|
729
783
|
# },
|
730
784
|
# budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
|
731
785
|
# last_updated_time: Time.now,
|
786
|
+
# auto_adjust_data: {
|
787
|
+
# auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
|
788
|
+
# historical_options: {
|
789
|
+
# budget_adjustment_period: 1, # required
|
790
|
+
# look_back_available_periods: 1,
|
791
|
+
# },
|
792
|
+
# last_auto_adjust_time: Time.now,
|
793
|
+
# },
|
732
794
|
# },
|
733
795
|
# notifications_with_subscribers: [
|
734
796
|
# {
|
@@ -761,8 +823,8 @@ module Aws::Budgets
|
|
761
823
|
# A notification that you want to associate with a budget. A budget
|
762
824
|
# can have up to five notifications, and each notification can have
|
763
825
|
# one SNS subscriber and up to 10 email subscribers. If you include
|
764
|
-
# notifications and subscribers in your `CreateBudget` call,
|
765
|
-
# creates the notifications and subscribers for you.
|
826
|
+
# notifications and subscribers in your `CreateBudget` call, Amazon
|
827
|
+
# Web Services creates the notifications and subscribers for you.
|
766
828
|
# @return [Array<Types::NotificationWithSubscribers>]
|
767
829
|
#
|
768
830
|
class CreateBudgetRequest < Struct.new(
|
@@ -806,8 +868,8 @@ module Aws::Budgets
|
|
806
868
|
# @return [String]
|
807
869
|
#
|
808
870
|
# @!attribute [rw] budget_name
|
809
|
-
# The name of the budget that you want
|
810
|
-
# names must be unique within an account.
|
871
|
+
# The name of the budget that you want Amazon Web Services to notify
|
872
|
+
# you about. Budget names must be unique within an account.
|
811
873
|
# @return [String]
|
812
874
|
#
|
813
875
|
# @!attribute [rw] notification
|
@@ -922,8 +984,7 @@ module Aws::Budgets
|
|
922
984
|
# }
|
923
985
|
#
|
924
986
|
# @!attribute [rw] iam_action_definition
|
925
|
-
# The
|
926
|
-
# details.
|
987
|
+
# The Identity and Access Management (IAM) action definition details.
|
927
988
|
# @return [Types::IamActionDefinition]
|
928
989
|
#
|
929
990
|
# @!attribute [rw] scp_action_definition
|
@@ -931,7 +992,8 @@ module Aws::Budgets
|
|
931
992
|
# @return [Types::ScpActionDefinition]
|
932
993
|
#
|
933
994
|
# @!attribute [rw] ssm_action_definition
|
934
|
-
# The
|
995
|
+
# The Amazon Web Services Systems Manager (SSM) action definition
|
996
|
+
# details.
|
935
997
|
# @return [Types::SsmActionDefinition]
|
936
998
|
#
|
937
999
|
class Definition < Struct.new(
|
@@ -952,7 +1014,7 @@ module Aws::Budgets
|
|
952
1014
|
# }
|
953
1015
|
#
|
954
1016
|
# @!attribute [rw] account_id
|
955
|
-
# The account ID of the user. It
|
1017
|
+
# The account ID of the user. It's a 12-digit number.
|
956
1018
|
# @return [String]
|
957
1019
|
#
|
958
1020
|
# @!attribute [rw] budget_name
|
@@ -974,7 +1036,7 @@ module Aws::Budgets
|
|
974
1036
|
end
|
975
1037
|
|
976
1038
|
# @!attribute [rw] account_id
|
977
|
-
# The account ID of the user. It
|
1039
|
+
# The account ID of the user. It's a 12-digit number.
|
978
1040
|
# @return [String]
|
979
1041
|
#
|
980
1042
|
# @!attribute [rw] budget_name
|
@@ -1133,7 +1195,7 @@ module Aws::Budgets
|
|
1133
1195
|
# }
|
1134
1196
|
#
|
1135
1197
|
# @!attribute [rw] account_id
|
1136
|
-
# The account ID of the user. It
|
1198
|
+
# The account ID of the user. It's a 12-digit number.
|
1137
1199
|
# @return [String]
|
1138
1200
|
#
|
1139
1201
|
# @!attribute [rw] budget_name
|
@@ -1147,7 +1209,7 @@ module Aws::Budgets
|
|
1147
1209
|
# @return [String]
|
1148
1210
|
#
|
1149
1211
|
# @!attribute [rw] time_period
|
1150
|
-
# The period of time that
|
1212
|
+
# The period of time that's covered by a budget. The period has a
|
1151
1213
|
# start date and an end date. The start date must come before the end
|
1152
1214
|
# date. There are no restrictions on the end date.
|
1153
1215
|
# @return [Types::TimePeriod]
|
@@ -1197,7 +1259,7 @@ module Aws::Budgets
|
|
1197
1259
|
# }
|
1198
1260
|
#
|
1199
1261
|
# @!attribute [rw] account_id
|
1200
|
-
# The account ID of the user. It
|
1262
|
+
# The account ID of the user. It's a 12-digit number.
|
1201
1263
|
# @return [String]
|
1202
1264
|
#
|
1203
1265
|
# @!attribute [rw] budget_name
|
@@ -1219,7 +1281,7 @@ module Aws::Budgets
|
|
1219
1281
|
end
|
1220
1282
|
|
1221
1283
|
# @!attribute [rw] account_id
|
1222
|
-
# The account ID of the user. It
|
1284
|
+
# The account ID of the user. It's a 12-digit number.
|
1223
1285
|
# @return [String]
|
1224
1286
|
#
|
1225
1287
|
# @!attribute [rw] budget_name
|
@@ -1249,7 +1311,7 @@ module Aws::Budgets
|
|
1249
1311
|
# }
|
1250
1312
|
#
|
1251
1313
|
# @!attribute [rw] account_id
|
1252
|
-
# The account ID of the user. It
|
1314
|
+
# The account ID of the user. It's a 12-digit number.
|
1253
1315
|
# @return [String]
|
1254
1316
|
#
|
1255
1317
|
# @!attribute [rw] max_results
|
@@ -1295,7 +1357,7 @@ module Aws::Budgets
|
|
1295
1357
|
# }
|
1296
1358
|
#
|
1297
1359
|
# @!attribute [rw] account_id
|
1298
|
-
# The account ID of the user. It
|
1360
|
+
# The account ID of the user. It's a 12-digit number.
|
1299
1361
|
# @return [String]
|
1300
1362
|
#
|
1301
1363
|
# @!attribute [rw] budget_name
|
@@ -1351,7 +1413,7 @@ module Aws::Budgets
|
|
1351
1413
|
# }
|
1352
1414
|
#
|
1353
1415
|
# @!attribute [rw] account_id
|
1354
|
-
# The account ID of the user. It
|
1416
|
+
# The account ID of the user. It's a 12-digit number.
|
1355
1417
|
# @return [String]
|
1356
1418
|
#
|
1357
1419
|
# @!attribute [rw] budget_name
|
@@ -1646,7 +1708,7 @@ module Aws::Budgets
|
|
1646
1708
|
# }
|
1647
1709
|
#
|
1648
1710
|
# @!attribute [rw] account_id
|
1649
|
-
# The account ID of the user. It
|
1711
|
+
# The account ID of the user. It's a 12-digit number.
|
1650
1712
|
# @return [String]
|
1651
1713
|
#
|
1652
1714
|
# @!attribute [rw] budget_name
|
@@ -1673,7 +1735,7 @@ module Aws::Budgets
|
|
1673
1735
|
end
|
1674
1736
|
|
1675
1737
|
# @!attribute [rw] account_id
|
1676
|
-
# The account ID of the user. It
|
1738
|
+
# The account ID of the user. It's a 12-digit number.
|
1677
1739
|
# @return [String]
|
1678
1740
|
#
|
1679
1741
|
# @!attribute [rw] budget_name
|
@@ -1711,8 +1773,56 @@ module Aws::Budgets
|
|
1711
1773
|
include Aws::Structure
|
1712
1774
|
end
|
1713
1775
|
|
1714
|
-
# The
|
1715
|
-
#
|
1776
|
+
# The parameters that define or describe the historical data that your
|
1777
|
+
# auto-adjusting budget is based on.
|
1778
|
+
#
|
1779
|
+
# @note When making an API call, you may pass HistoricalOptions
|
1780
|
+
# data as a hash:
|
1781
|
+
#
|
1782
|
+
# {
|
1783
|
+
# budget_adjustment_period: 1, # required
|
1784
|
+
# look_back_available_periods: 1,
|
1785
|
+
# }
|
1786
|
+
#
|
1787
|
+
# @!attribute [rw] budget_adjustment_period
|
1788
|
+
# The number of budget periods included in the moving-average
|
1789
|
+
# calculation that determines your auto-adjusted budget amount. The
|
1790
|
+
# maximum value depends on the `TimeUnit` granularity of the budget:
|
1791
|
+
#
|
1792
|
+
# * For the `DAILY` granularity, the maximum value is `60`.
|
1793
|
+
#
|
1794
|
+
# * For the `MONTHLY` granularity, the maximum value is `12`.
|
1795
|
+
#
|
1796
|
+
# * For the `QUARTERLY` granularity, the maximum value is `4`.
|
1797
|
+
#
|
1798
|
+
# * For the `ANNUALLY` granularity, the maximum value is `1`.
|
1799
|
+
# @return [Integer]
|
1800
|
+
#
|
1801
|
+
# @!attribute [rw] look_back_available_periods
|
1802
|
+
# The integer that describes how many budget periods in your
|
1803
|
+
# `BudgetAdjustmentPeriod` are included in the calculation of your
|
1804
|
+
# current `BudgetLimit`. If the first budget period in your
|
1805
|
+
# `BudgetAdjustmentPeriod` has no cost data, then that budget period
|
1806
|
+
# isn’t included in the average that determines your budget limit.
|
1807
|
+
#
|
1808
|
+
# For example, if you set `BudgetAdjustmentPeriod` as `4` quarters,
|
1809
|
+
# but your account had no cost data in the first quarter, then only
|
1810
|
+
# the last three quarters are included in the calculation. In this
|
1811
|
+
# scenario, `LookBackAvailablePeriods` returns `3`.
|
1812
|
+
#
|
1813
|
+
# You can’t set your own `LookBackAvailablePeriods`. The value is
|
1814
|
+
# automatically calculated from the `BudgetAdjustmentPeriod` and your
|
1815
|
+
# historical cost data.
|
1816
|
+
# @return [Integer]
|
1817
|
+
#
|
1818
|
+
class HistoricalOptions < Struct.new(
|
1819
|
+
:budget_adjustment_period,
|
1820
|
+
:look_back_available_periods)
|
1821
|
+
SENSITIVE = []
|
1822
|
+
include Aws::Structure
|
1823
|
+
end
|
1824
|
+
|
1825
|
+
# The Identity and Access Management (IAM) action definition details.
|
1716
1826
|
#
|
1717
1827
|
# @note When making an API call, you may pass IamActionDefinition
|
1718
1828
|
# data as a hash:
|
@@ -1799,7 +1909,7 @@ module Aws::Budgets
|
|
1799
1909
|
include Aws::Structure
|
1800
1910
|
end
|
1801
1911
|
|
1802
|
-
# A notification that
|
1912
|
+
# A notification that's associated with a budget. A budget can have up
|
1803
1913
|
# to ten notifications.
|
1804
1914
|
#
|
1805
1915
|
# Each notification must have at least one subscriber. A notification
|
@@ -1830,16 +1940,17 @@ module Aws::Budgets
|
|
1830
1940
|
# }
|
1831
1941
|
#
|
1832
1942
|
# @!attribute [rw] notification_type
|
1833
|
-
#
|
1834
|
-
# or for how much you're forecasted to spend
|
1943
|
+
# Specifies whether the notification is for how much you have spent
|
1944
|
+
# (`ACTUAL`) or for how much that you're forecasted to spend
|
1945
|
+
# (`FORECASTED`).
|
1835
1946
|
# @return [String]
|
1836
1947
|
#
|
1837
1948
|
# @!attribute [rw] comparison_operator
|
1838
|
-
# The comparison that
|
1949
|
+
# The comparison that's used for this notification.
|
1839
1950
|
# @return [String]
|
1840
1951
|
#
|
1841
1952
|
# @!attribute [rw] threshold
|
1842
|
-
# The threshold that
|
1953
|
+
# The threshold that's associated with a notification. Thresholds are
|
1843
1954
|
# always a percentage, and many customers find value being alerted
|
1844
1955
|
# between 50% - 200% of the budgeted amount. The maximum limit for
|
1845
1956
|
# your threshold is 1,000,000% above the budgeted amount.
|
@@ -1847,18 +1958,19 @@ module Aws::Budgets
|
|
1847
1958
|
#
|
1848
1959
|
# @!attribute [rw] threshold_type
|
1849
1960
|
# The type of threshold for a notification. For `ABSOLUTE_VALUE`
|
1850
|
-
# thresholds,
|
1851
|
-
# go over your total cost threshold. For `PERCENTAGE`
|
1852
|
-
# notifies you when you go over or are
|
1853
|
-
# percentage of your forecasted spend.
|
1854
|
-
# budget for 200 dollars and you have a
|
1855
|
-
#
|
1961
|
+
# thresholds, Amazon Web Services notifies you when you go over or are
|
1962
|
+
# forecasted to go over your total cost threshold. For `PERCENTAGE`
|
1963
|
+
# thresholds, Amazon Web Services notifies you when you go over or are
|
1964
|
+
# forecasted to go over a certain percentage of your forecasted spend.
|
1965
|
+
# For example, if you have a budget for 200 dollars and you have a
|
1966
|
+
# `PERCENTAGE` threshold of 80%, Amazon Web Services notifies you when
|
1967
|
+
# you go over 160 dollars.
|
1856
1968
|
# @return [String]
|
1857
1969
|
#
|
1858
1970
|
# @!attribute [rw] notification_state
|
1859
|
-
#
|
1860
|
-
# in the `ALARM` state, you
|
1861
|
-
# budget.
|
1971
|
+
# Specifies whether this notification is in alarm. If a budget
|
1972
|
+
# notification is in the `ALARM` state, you passed the set threshold
|
1973
|
+
# for the budget.
|
1862
1974
|
# @return [String]
|
1863
1975
|
#
|
1864
1976
|
class Notification < Struct.new(
|
@@ -1895,7 +2007,7 @@ module Aws::Budgets
|
|
1895
2007
|
# }
|
1896
2008
|
#
|
1897
2009
|
# @!attribute [rw] notification
|
1898
|
-
# The notification that
|
2010
|
+
# The notification that's associated with a budget.
|
1899
2011
|
# @return [Types::Notification]
|
1900
2012
|
#
|
1901
2013
|
# @!attribute [rw] subscribers
|
@@ -1947,9 +2059,9 @@ module Aws::Budgets
|
|
1947
2059
|
include Aws::Structure
|
1948
2060
|
end
|
1949
2061
|
|
1950
|
-
# The amount of cost or usage that
|
2062
|
+
# The amount of cost or usage that's measured for a budget.
|
1951
2063
|
#
|
1952
|
-
# For example, a `Spend` for `3 GB` of S3 usage
|
2064
|
+
# For example, a `Spend` for `3 GB` of S3 usage has the following
|
1953
2065
|
# parameters:
|
1954
2066
|
#
|
1955
2067
|
# * An `Amount` of `3`
|
@@ -1965,13 +2077,13 @@ module Aws::Budgets
|
|
1965
2077
|
# }
|
1966
2078
|
#
|
1967
2079
|
# @!attribute [rw] amount
|
1968
|
-
# The cost or usage amount that
|
2080
|
+
# The cost or usage amount that's associated with a budget forecast,
|
1969
2081
|
# actual spend, or budget threshold.
|
1970
2082
|
# @return [String]
|
1971
2083
|
#
|
1972
2084
|
# @!attribute [rw] unit
|
1973
|
-
# The unit of measurement that
|
1974
|
-
# spend, or budget threshold, such as
|
2085
|
+
# The unit of measurement that's used for the budget forecast, actual
|
2086
|
+
# spend, or budget threshold, such as USD or GBP.
|
1975
2087
|
# @return [String]
|
1976
2088
|
#
|
1977
2089
|
class Spend < Struct.new(
|
@@ -1981,7 +2093,8 @@ module Aws::Budgets
|
|
1981
2093
|
include Aws::Structure
|
1982
2094
|
end
|
1983
2095
|
|
1984
|
-
# The
|
2096
|
+
# The Amazon Web Services Systems Manager (SSM) action definition
|
2097
|
+
# details.
|
1985
2098
|
#
|
1986
2099
|
# @note When making an API call, you may pass SsmActionDefinition
|
1987
2100
|
# data as a hash:
|
@@ -2015,7 +2128,7 @@ module Aws::Budgets
|
|
2015
2128
|
# The subscriber to a budget notification. The subscriber consists of a
|
2016
2129
|
# subscription type and either an Amazon SNS topic or an email address.
|
2017
2130
|
#
|
2018
|
-
# For example, an email subscriber
|
2131
|
+
# For example, an email subscriber has the following parameters:
|
2019
2132
|
#
|
2020
2133
|
# * A `subscriptionType` of `EMAIL`
|
2021
2134
|
#
|
@@ -2030,12 +2143,13 @@ module Aws::Budgets
|
|
2030
2143
|
# }
|
2031
2144
|
#
|
2032
2145
|
# @!attribute [rw] subscription_type
|
2033
|
-
# The type of notification that
|
2146
|
+
# The type of notification that Amazon Web Services sends to a
|
2147
|
+
# subscriber.
|
2034
2148
|
# @return [String]
|
2035
2149
|
#
|
2036
2150
|
# @!attribute [rw] address
|
2037
|
-
# The address that
|
2038
|
-
# topic or an email.
|
2151
|
+
# The address that Amazon Web Services sends budget notifications to,
|
2152
|
+
# either an SNS topic or an email.
|
2039
2153
|
#
|
2040
2154
|
# When you create a subscriber, the value of `Address` can't contain
|
2041
2155
|
# line breaks.
|
@@ -2048,7 +2162,7 @@ module Aws::Budgets
|
|
2048
2162
|
include Aws::Structure
|
2049
2163
|
end
|
2050
2164
|
|
2051
|
-
# The period of time that
|
2165
|
+
# The period of time that's covered by a budget. The period has a start
|
2052
2166
|
# date and an end date. The start date must come before the end date.
|
2053
2167
|
# There are no restrictions on the end date.
|
2054
2168
|
#
|
@@ -2062,25 +2176,27 @@ module Aws::Budgets
|
|
2062
2176
|
#
|
2063
2177
|
# @!attribute [rw] start
|
2064
2178
|
# The start date for a budget. If you created your budget and didn't
|
2065
|
-
# specify a start date,
|
2066
|
-
# period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY).
|
2067
|
-
# created your budget on January 24, 2018, chose
|
2068
|
-
# set a start date,
|
2069
|
-
#
|
2070
|
-
#
|
2071
|
-
#
|
2179
|
+
# specify a start date, Amazon Web Services defaults to the start of
|
2180
|
+
# your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY).
|
2181
|
+
# For example, if you created your budget on January 24, 2018, chose
|
2182
|
+
# `DAILY`, and didn't set a start date, Amazon Web Services set your
|
2183
|
+
# start date to `01/24/18 00:00 UTC`. If you chose `MONTHLY`, Amazon
|
2184
|
+
# Web Services set your start date to `01/01/18 00:00 UTC`. The
|
2185
|
+
# defaults are the same for the Billing and Cost Management console
|
2186
|
+
# and the API.
|
2072
2187
|
#
|
2073
2188
|
# You can change your start date with the `UpdateBudget` operation.
|
2074
2189
|
# @return [Time]
|
2075
2190
|
#
|
2076
2191
|
# @!attribute [rw] end
|
2077
|
-
# The end date for a budget. If you didn't specify an end date,
|
2078
|
-
# set your end date to `06/15/87 00:00 UTC`. The
|
2079
|
-
# for the
|
2080
|
-
#
|
2081
|
-
#
|
2082
|
-
#
|
2083
|
-
#
|
2192
|
+
# The end date for a budget. If you didn't specify an end date,
|
2193
|
+
# Amazon Web Services set your end date to `06/15/87 00:00 UTC`. The
|
2194
|
+
# defaults are the same for the Billing and Cost Management console
|
2195
|
+
# and the API.
|
2196
|
+
#
|
2197
|
+
# After the end date, Amazon Web Services deletes the budget and all
|
2198
|
+
# the associated notifications and subscribers. You can change your
|
2199
|
+
# end date with the `UpdateBudget` operation.
|
2084
2200
|
# @return [Time]
|
2085
2201
|
#
|
2086
2202
|
class TimePeriod < Struct.new(
|
@@ -2130,7 +2246,7 @@ module Aws::Budgets
|
|
2130
2246
|
# }
|
2131
2247
|
#
|
2132
2248
|
# @!attribute [rw] account_id
|
2133
|
-
# The account ID of the user. It
|
2249
|
+
# The account ID of the user. It's a 12-digit number.
|
2134
2250
|
# @return [String]
|
2135
2251
|
#
|
2136
2252
|
# @!attribute [rw] budget_name
|
@@ -2183,7 +2299,7 @@ module Aws::Budgets
|
|
2183
2299
|
end
|
2184
2300
|
|
2185
2301
|
# @!attribute [rw] account_id
|
2186
|
-
# The account ID of the user. It
|
2302
|
+
# The account ID of the user. It's a 12-digit number.
|
2187
2303
|
# @return [String]
|
2188
2304
|
#
|
2189
2305
|
# @!attribute [rw] budget_name
|
@@ -2260,6 +2376,14 @@ module Aws::Budgets
|
|
2260
2376
|
# },
|
2261
2377
|
# budget_type: "USAGE", # required, accepts USAGE, COST, RI_UTILIZATION, RI_COVERAGE, SAVINGS_PLANS_UTILIZATION, SAVINGS_PLANS_COVERAGE
|
2262
2378
|
# last_updated_time: Time.now,
|
2379
|
+
# auto_adjust_data: {
|
2380
|
+
# auto_adjust_type: "HISTORICAL", # required, accepts HISTORICAL, FORECAST
|
2381
|
+
# historical_options: {
|
2382
|
+
# budget_adjustment_period: 1, # required
|
2383
|
+
# look_back_available_periods: 1,
|
2384
|
+
# },
|
2385
|
+
# last_auto_adjust_time: Time.now,
|
2386
|
+
# },
|
2263
2387
|
# },
|
2264
2388
|
# }
|
2265
2389
|
#
|
data/lib/aws-sdk-budgets.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-budgets
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.47.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-02-
|
11
|
+
date: 2022-02-16 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|