Class: Aws::SavingsPlans::Types::DescribeSavingsPlansRequest

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

Overview

Note:

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

{
  savings_plan_arns: ["SavingsPlanArn"],
  savings_plan_ids: ["SavingsPlanId"],
  next_token: "PaginationToken",
  max_results: 1,
  states: ["payment-pending"], # accepts payment-pending, payment-failed, active, retired
  filters: [
    {
      name: "region", # accepts region, ec2-instance-family, commitment, upfront, term, savings-plan-type, payment-option, start, end
      values: ["String"],
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::SavingsPlanFilter>

The filters.

Returns:



404
405
406
407
408
409
410
411
412
413
# File 'gems/aws-sdk-savingsplans/lib/aws-sdk-savingsplans/types.rb', line 404

class DescribeSavingsPlansRequest < Struct.new(
  :savings_plan_arns,
  :savings_plan_ids,
  :next_token,
  :max_results,
  :states,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return with a single call. To retrieve additional results, make another call with the returned token value.

Returns:

  • (Integer)


404
405
406
407
408
409
410
411
412
413
# File 'gems/aws-sdk-savingsplans/lib/aws-sdk-savingsplans/types.rb', line 404

class DescribeSavingsPlansRequest < Struct.new(
  :savings_plan_arns,
  :savings_plan_ids,
  :next_token,
  :max_results,
  :states,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token for the next page of results.

Returns:

  • (String)


404
405
406
407
408
409
410
411
412
413
# File 'gems/aws-sdk-savingsplans/lib/aws-sdk-savingsplans/types.rb', line 404

class DescribeSavingsPlansRequest < Struct.new(
  :savings_plan_arns,
  :savings_plan_ids,
  :next_token,
  :max_results,
  :states,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#savings_plan_arnsArray<String>

The Amazon Resource Names (ARN) of the Savings Plans.

Returns:

  • (Array<String>)


404
405
406
407
408
409
410
411
412
413
# File 'gems/aws-sdk-savingsplans/lib/aws-sdk-savingsplans/types.rb', line 404

class DescribeSavingsPlansRequest < Struct.new(
  :savings_plan_arns,
  :savings_plan_ids,
  :next_token,
  :max_results,
  :states,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#savings_plan_idsArray<String>

The IDs of the Savings Plans.

Returns:

  • (Array<String>)


404
405
406
407
408
409
410
411
412
413
# File 'gems/aws-sdk-savingsplans/lib/aws-sdk-savingsplans/types.rb', line 404

class DescribeSavingsPlansRequest < Struct.new(
  :savings_plan_arns,
  :savings_plan_ids,
  :next_token,
  :max_results,
  :states,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end

#statesArray<String>

The states.

Returns:

  • (Array<String>)


404
405
406
407
408
409
410
411
412
413
# File 'gems/aws-sdk-savingsplans/lib/aws-sdk-savingsplans/types.rb', line 404

class DescribeSavingsPlansRequest < Struct.new(
  :savings_plan_arns,
  :savings_plan_ids,
  :next_token,
  :max_results,
  :states,
  :filters)
  SENSITIVE = []
  include Aws::Structure
end