Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Budget = Budget' {
- autoAdjustData :: Maybe AutoAdjustData
- budgetLimit :: Maybe Spend
- calculatedSpend :: Maybe CalculatedSpend
- costFilters :: Maybe (HashMap Text [Text])
- costTypes :: Maybe CostTypes
- lastUpdatedTime :: Maybe POSIX
- plannedBudgetLimits :: Maybe (HashMap Text Spend)
- timePeriod :: Maybe TimePeriod
- budgetName :: Text
- timeUnit :: TimeUnit
- budgetType :: BudgetType
- newBudget :: Text -> TimeUnit -> BudgetType -> Budget
- budget_autoAdjustData :: Lens' Budget (Maybe AutoAdjustData)
- budget_budgetLimit :: Lens' Budget (Maybe Spend)
- budget_calculatedSpend :: Lens' Budget (Maybe CalculatedSpend)
- budget_costFilters :: Lens' Budget (Maybe (HashMap Text [Text]))
- budget_costTypes :: Lens' Budget (Maybe CostTypes)
- budget_lastUpdatedTime :: Lens' Budget (Maybe UTCTime)
- budget_plannedBudgetLimits :: Lens' Budget (Maybe (HashMap Text Spend))
- budget_timePeriod :: Lens' Budget (Maybe TimePeriod)
- budget_budgetName :: Lens' Budget Text
- budget_timeUnit :: Lens' Budget TimeUnit
- budget_budgetType :: Lens' Budget BudgetType
Documentation
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 Amazon Resource Name (ARN) pattern for a budget:
arn:aws:budgets::AccountId:budget/budgetName
See: newBudget
smart constructor.
Budget' | |
|
Instances
:: Text | |
-> TimeUnit | |
-> BudgetType | |
-> Budget |
Create a value of Budget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoAdjustData:Budget'
, budget_autoAdjustData
- The parameters that determine the budget amount for an auto-adjusting
budget.
$sel:budgetLimit:Budget'
, budget_budgetLimit
- 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.
$sel:calculatedSpend:Budget'
, budget_calculatedSpend
- The actual and forecasted cost or usage that the budget tracks.
$sel:costFilters:Budget'
, budget_costFilters
- 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:
- Amazon EC2
- Amazon Redshift
- Amazon Relational Database Service
- Amazon ElastiCache
- Amazon OpenSearch Service
$sel:costTypes:Budget'
, budget_costTypes
- 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
.
$sel:lastUpdatedTime:Budget'
, budget_lastUpdatedTime
- The last time that you updated this budget.
$sel:plannedBudgetLimits:Budget'
, budget_plannedBudgetLimits
- 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
.
$sel:timePeriod:Budget'
, budget_timePeriod
- 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.
$sel:budgetName:Budget'
, budget_budgetName
- The name of a budget. The name must be unique within an account. The :
and \
characters aren't allowed in BudgetName
.
$sel:timeUnit:Budget'
, budget_timeUnit
- The length of time until a budget resets the actual and forecasted
spend.
$sel:budgetType:Budget'
, budget_budgetType
- Specifies whether this budget tracks costs, usage, RI utilization, RI
coverage, Savings Plans utilization, or Savings Plans coverage.
budget_autoAdjustData :: Lens' Budget (Maybe AutoAdjustData) Source #
The parameters that determine the budget amount for an auto-adjusting budget.
budget_budgetLimit :: Lens' Budget (Maybe Spend) Source #
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.
budget_calculatedSpend :: Lens' Budget (Maybe CalculatedSpend) Source #
The actual and forecasted cost or usage that the budget tracks.
budget_costFilters :: Lens' Budget (Maybe (HashMap Text [Text])) Source #
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:
- Amazon EC2
- Amazon Redshift
- Amazon Relational Database Service
- Amazon ElastiCache
- Amazon OpenSearch Service
budget_costTypes :: Lens' Budget (Maybe CostTypes) Source #
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
.
budget_lastUpdatedTime :: Lens' Budget (Maybe UTCTime) Source #
The last time that you updated this budget.
budget_plannedBudgetLimits :: Lens' Budget (Maybe (HashMap Text Spend)) Source #
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
.
budget_timePeriod :: Lens' Budget (Maybe TimePeriod) Source #
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.
budget_budgetName :: Lens' Budget Text Source #
The name of a budget. The name must be unique within an account. The :
and \
characters aren't allowed in BudgetName
.
budget_timeUnit :: Lens' Budget TimeUnit Source #
The length of time until a budget resets the actual and forecasted spend.
budget_budgetType :: Lens' Budget BudgetType Source #
Specifies whether this budget tracks costs, usage, RI utilization, RI coverage, Savings Plans utilization, or Savings Plans coverage.