Amazonka.Budgets.Types.HistoricalOptions

Documentation

data HistoricalOptions

The parameters that define or describe the historical data that your auto-adjusting budget is based on.

See: newHistoricalOptions smart constructor.

Constructors

HistoricalOptions'

Fields

• lookBackAvailablePeriods :: Maybe Natural

  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.

• budgetAdjustmentPeriod :: Natural

  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.

Instances

FromJSON HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

parseJSON :: Value -> Parser HistoricalOptions

parseJSONList :: Value -> Parser [HistoricalOptions]

ToJSON HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

toJSON :: HistoricalOptions -> Value

toEncoding :: HistoricalOptions -> Encoding

toJSONList :: [HistoricalOptions] -> Value

toEncodingList :: [HistoricalOptions] -> Encoding

Generic HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Associated Types

type Rep HistoricalOptions :: Type -> Type

Methods

from :: HistoricalOptions -> Rep HistoricalOptions x

to :: Rep HistoricalOptions x -> HistoricalOptions

Read HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

readsPrec :: Int -> ReadS HistoricalOptions

readList :: ReadS [HistoricalOptions]

readPrec :: ReadPrec HistoricalOptions

readListPrec :: ReadPrec [HistoricalOptions]

Show HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

showsPrec :: Int -> HistoricalOptions -> ShowS

show :: HistoricalOptions -> String

showList :: [HistoricalOptions] -> ShowS

NFData HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

rnf :: HistoricalOptions -> ()

Eq HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

(==) :: HistoricalOptions -> HistoricalOptions -> Bool

(/=) :: HistoricalOptions -> HistoricalOptions -> Bool

Hashable HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

Methods

hashWithSalt :: Int -> HistoricalOptions -> Int

hash :: HistoricalOptions -> Int

type Rep HistoricalOptions

Defined in Amazonka.Budgets.Types.HistoricalOptions

type Rep HistoricalOptions = D1 ('MetaData "HistoricalOptions" "Amazonka.Budgets.Types.HistoricalOptions" "amazonka-budgets-2.0-7U1RWOWP6pxJESvTUhAD5Y" 'False) (C1 ('MetaCons "HistoricalOptions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "lookBackAvailablePeriods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "budgetAdjustmentPeriod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))

newHistoricalOptions

Arguments

:: Natural

$sel:budgetAdjustmentPeriod:HistoricalOptions'

-> HistoricalOptions

Create a value of HistoricalOptions 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:lookBackAvailablePeriods:HistoricalOptions', historicalOptions_lookBackAvailablePeriods - 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.

$sel:budgetAdjustmentPeriod:HistoricalOptions', historicalOptions_budgetAdjustmentPeriod - 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.

historicalOptions_lookBackAvailablePeriods :: Lens' HistoricalOptions (Maybe Natural)

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.

historicalOptions_budgetAdjustmentPeriod :: Lens' HistoricalOptions Natural

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.