Describe Savings Plans

savingsplans_describe_savings_plans

R Documentation

Describes the specified Savings Plans

Description

Describes the specified Savings Plans.

Usage

savingsplans_describe_savings_plans(savingsPlanArns, savingsPlanIds,
  nextToken, maxResults, states, filters)

Arguments

savingsPlanArns

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

savingsPlanIds

The IDs of the Savings Plans.

nextToken

The token for the next page of results.

maxResults

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

states

The current states of the Savings Plans.

filters

The filters.

Value

A list with the following syntax:

list(
  savingsPlans = list(
    list(
      offeringId = "string",
      savingsPlanId = "string",
      savingsPlanArn = "string",
      description = "string",
      start = "string",
      end = "string",
      state = "payment-pending"|"payment-failed"|"active"|"retired"|"queued"|"queued-deleted"|"pending-return"|"returned",
      region = "string",
      ec2InstanceFamily = "string",
      savingsPlanType = "Compute"|"EC2Instance"|"SageMaker",
      paymentOption = "All Upfront"|"Partial Upfront"|"No Upfront",
      productTypes = list(
        "EC2"|"Fargate"|"Lambda"|"SageMaker"
      ),
      currency = "CNY"|"USD",
      commitment = "string",
      upfrontPaymentAmount = "string",
      recurringPaymentAmount = "string",
      termDurationInSeconds = 123,
      tags = list(
        "string"
      ),
      returnableUntil = "string"
    )
  ),
  nextToken = "string"
)

Request syntax

svc$describe_savings_plans(
  savingsPlanArns = list(
    "string"
  ),
  savingsPlanIds = list(
    "string"
  ),
  nextToken = "string",
  maxResults = 123,
  states = list(
    "payment-pending"|"payment-failed"|"active"|"retired"|"queued"|"queued-deleted"|"pending-return"|"returned"
  ),
  filters = list(
    list(
      name = "region"|"ec2-instance-family"|"commitment"|"upfront"|"term"|"savings-plan-type"|"payment-option"|"start"|"end",
      values = list(
        "string"
      )
    )
  )
)