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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeSavingsPlansRequest as input to an Aws::Client method, you can use a vanilla 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, queued, queued-deleted
  filters: [
    {
      name: "region", # accepts region, ec2-instance-family, commitment, upfront, term, savings-plan-type, payment-option, start, end
      values: ["String"],
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Array<Types::SavingsPlanFilter>

The filters.

Returns:

#max_results ⇒ Integer

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) —

    The maximum number of results to return with a single call.

#next_token ⇒ String

The token for the next page of results.

Returns:

  • (String) —

    The token for the next page of results.

#savings_plan_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#savings_plan_ids ⇒ Array<String>

The IDs of the Savings Plans.

Returns:

  • (Array<String>) —

    The IDs of the Savings Plans.

#states ⇒ Array<String>

The states.

Returns:

  • (Array<String>) —

    The states.