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

Inherits:

Struct

• Object
• Struct
• Aws::Budgets::Types::DescribeBudgetPerformanceHistoryRequest

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",
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #account_id ⇒ String

  The account ID of the user.

• #budget_name ⇒ String

  A string that represents the budget name.

• #max_results ⇒ Integer

  An integer that represents how many entries a paginated response contains.

• #next_token ⇒ String

  A generic string.

• #time_period ⇒ Types::TimePeriod

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

Instance Attribute Details

#account_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1376

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

#budget_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1376

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1376

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

#next_token ⇒ String

A generic string.

Returns:

• (String)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1376

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

#time_period ⇒ Types::TimePeriod

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

Returns:

• (Types::TimePeriod)

# File 'gems/aws-sdk-budgets/lib/aws-sdk-budgets/types.rb', line 1376

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