You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::Budgets::Types::DescribeBudgetPerformanceHistoryRequest

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 DescribeBudgetPerformanceHistoryRequest data as a hash:

{
  account_id: "AccountId", # required
  budget_name: "BudgetName", # required
  time_period: {
    start: Time.now,
    end: Time.now,
  },
  max_results: 1,
  next_token: "GenericString",
}

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The account ID of the user. It should be a 12-digit number.

Returns:

  • (String)


783
784
785
786
787
788
789
790
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 783

class DescribeBudgetPerformanceHistoryRequest < Struct.new(
  :account_id,
  :budget_name,
  :time_period,
  :max_results,
  :next_token)
  include Aws::Structure
end

#budget_nameString

A string that represents the budget name. The ":" and "\" characters aren't allowed.

Returns:

  • (String)


783
784
785
786
787
788
789
790
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 783

class DescribeBudgetPerformanceHistoryRequest < Struct.new(
  :account_id,
  :budget_name,
  :time_period,
  :max_results,
  :next_token)
  include Aws::Structure
end

#max_resultsInteger

An integer that represents how many entries a paginated response contains. The maximum is 100.

Returns:

  • (Integer)


783
784
785
786
787
788
789
790
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 783

class DescribeBudgetPerformanceHistoryRequest < Struct.new(
  :account_id,
  :budget_name,
  :time_period,
  :max_results,
  :next_token)
  include Aws::Structure
end

#next_tokenString

A generic string.

Returns:

  • (String)


783
784
785
786
787
788
789
790
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 783

class DescribeBudgetPerformanceHistoryRequest < Struct.new(
  :account_id,
  :budget_name,
  :time_period,
  :max_results,
  :next_token)
  include Aws::Structure
end

#time_periodTypes::TimePeriod

Retrieves how often the budget went into an ALARM state for the specified time period.

Returns:



783
784
785
786
787
788
789
790
# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 783

class DescribeBudgetPerformanceHistoryRequest < Struct.new(
  :account_id,
  :budget_name,
  :time_period,
  :max_results,
  :next_token)
  include Aws::Structure
end