Create Budget
budgets_create_budget | R Documentation |
Creates a budget and, if included, notifications and subscribers¶
Description¶
Creates a budget and, if included, notifications and subscribers.
Only one of BudgetLimit
or PlannedBudgetLimits
can be present in the
syntax at one time. Use the syntax that matches your case. The Request
Syntax section shows the BudgetLimit
syntax. For
PlannedBudgetLimits
, see the
Examples
section.
Usage¶
budgets_create_budget(AccountId, Budget, NotificationsWithSubscribers,
ResourceTags)
Arguments¶
AccountId |
[required] The |
Budget |
[required] The budget object that you want to create. |
NotificationsWithSubscribers |
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 |
ResourceTags |
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. |
Value¶
An empty list.
Request syntax¶
svc$create_budget(
AccountId = "string",
Budget = list(
BudgetName = "string",
BudgetLimit = list(
Amount = "string",
Unit = "string"
),
PlannedBudgetLimits = list(
list(
Amount = "string",
Unit = "string"
)
),
CostFilters = list(
list(
"string"
)
),
CostTypes = list(
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 = list(
Start = as.POSIXct(
"2015-01-01"
),
End = as.POSIXct(
"2015-01-01"
)
),
CalculatedSpend = list(
ActualSpend = list(
Amount = "string",
Unit = "string"
),
ForecastedSpend = list(
Amount = "string",
Unit = "string"
)
),
BudgetType = "USAGE"|"COST"|"RI_UTILIZATION"|"RI_COVERAGE"|"SAVINGS_PLANS_UTILIZATION"|"SAVINGS_PLANS_COVERAGE",
LastUpdatedTime = as.POSIXct(
"2015-01-01"
),
AutoAdjustData = list(
AutoAdjustType = "HISTORICAL"|"FORECAST",
HistoricalOptions = list(
BudgetAdjustmentPeriod = 123,
LookBackAvailablePeriods = 123
),
LastAutoAdjustTime = as.POSIXct(
"2015-01-01"
)
)
),
NotificationsWithSubscribers = list(
list(
Notification = list(
NotificationType = "ACTUAL"|"FORECASTED",
ComparisonOperator = "GREATER_THAN"|"LESS_THAN"|"EQUAL_TO",
Threshold = 123.0,
ThresholdType = "PERCENTAGE"|"ABSOLUTE_VALUE",
NotificationState = "OK"|"ALARM"
),
Subscribers = list(
list(
SubscriptionType = "SNS"|"EMAIL",
Address = "string"
)
)
)
),
ResourceTags = list(
list(
Key = "string",
Value = "string"
)
)
)