[ aws . savingsplans ]

describe-savings-plans

Description

Describes the specified Savings Plans.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-savings-plans
[--savings-plan-arns <value>]
[--savings-plan-ids <value>]
[--next-token <value>]
[--max-results <value>]
[--states <value>]
[--filters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--savings-plan-arns (list)

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

(string)

Syntax:

"string" "string" ...

--savings-plan-ids (list)

The IDs of the Savings Plans.

(string)

Syntax:

"string" "string" ...

--next-token (string)

The token for the next page of results.

--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.

--states (list)

The states.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  payment-pending
  payment-failed
  active
  retired
  queued
  queued-deleted

--filters (list)

The filters.

(structure)

Information about a filter.

name -> (string)

The filter name.

values -> (list)

The filter value.

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "region"|"ec2-instance-family"|"commitment"|"upfront"|"term"|"savings-plan-type"|"payment-option"|"start"|"end",
    "values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

savingsPlans -> (list)

Information about the Savings Plans.

(structure)

Information about a Savings Plan.

offeringId -> (string)

The ID of the offering.

savingsPlanId -> (string)

The ID of the Savings Plan.

savingsPlanArn -> (string)

The Amazon Resource Name (ARN) of the Savings Plan.

description -> (string)

The description.

start -> (string)

The start time.

end -> (string)

The end time.

state -> (string)

The state.

region -> (string)

The AWS Region.

ec2InstanceFamily -> (string)

The EC2 instance family.

savingsPlanType -> (string)

The plan type.

paymentOption -> (string)

The payment option.

productTypes -> (list)

The product types.

(string)

currency -> (string)

The currency.

commitment -> (string)

The hourly commitment, in USD.

upfrontPaymentAmount -> (string)

The up-front payment amount.

recurringPaymentAmount -> (string)

The recurring payment amount.

termDurationInSeconds -> (long)

The duration of the term, in seconds.

tags -> (map)

One or more tags.

key -> (string)

value -> (string)

nextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.