Class: Aws::Budgets::Types::HistoricalOptions

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb

Overview

Note:

When making an API call, you may pass HistoricalOptions data as a hash:

{
  budget_adjustment_period: 1, # required
  look_back_available_periods: 1,
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#budget_adjustment_periodInteger

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.

Returns:

  • (Integer)


1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1881

class HistoricalOptions < Struct.new(
  :budget_adjustment_period,
  :look_back_available_periods)
  SENSITIVE = []
  include Aws::Structure
end

#look_back_available_periodsInteger

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.

Returns:

  • (Integer)


1881
1882
1883
1884
1885
1886
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1881

class HistoricalOptions < Struct.new(
  :budget_adjustment_period,
  :look_back_available_periods)
  SENSITIVE = []
  include Aws::Structure
end