[ aws . savingsplans ]

describe-savings-plans-offerings

Description

Describes the specified Savings Plans offerings.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-savings-plans-offerings
[--offering-ids <value>]
[--payment-options <value>]
[--product-type <value>]
[--plan-types <value>]
[--durations <value>]
[--currencies <value>]
[--descriptions <value>]
[--service-codes <value>]
[--usage-types <value>]
[--operations <value>]
[--filters <value>]
[--next-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--offering-ids (list)

The IDs of the offerings.

(string)

Syntax:

"string" "string" ...

--payment-options (list)

The payment options.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  All Upfront
  Partial Upfront
  No Upfront

--product-type (string)

The product type.

Possible values:

• EC2

• Fargate

• Lambda

• SageMaker

--plan-types (list)

The plan type.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Compute
  EC2Instance
  SageMaker

--durations (list)

The durations, in seconds.

(long)

Syntax:

long long ...

--currencies (list)

The currencies.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  CNY
  USD

--descriptions (list)

The descriptions.

(string)

Syntax:

"string" "string" ...

--service-codes (list)

The services.

(string)

Syntax:

"string" "string" ...

--usage-types (list)

The usage details of the line item in the billing report.

(string)

Syntax:

"string" "string" ...

--operations (list)

The specific AWS operation for the line item in the billing report.

(string)

Syntax:

"string" "string" ...

--filters (list)

The filters.

(structure)

Information about a filter.

name -> (string)

The filter name.

values -> (list)

The filter values.

(string)

Shorthand Syntax:

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

JSON Syntax:

[
  {
    "name": "region"|"instanceFamily",
    "values": ["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.

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

searchResults -> (list)

Information about the Savings Plans offerings.

(structure)

Information about a Savings Plan offering.

offeringId -> (string)

The ID of the offering.

productTypes -> (list)

The product type.

(string)

planType -> (string)

The plan type.

description -> (string)

The description.

paymentOption -> (string)

The payment option.

durationSeconds -> (long)

The duration, in seconds.

currency -> (string)

The currency.

serviceCode -> (string)

The service.

usageType -> (string)

The usage details of the line item in the billing report.

operation -> (string)

The specific AWS operation for the line item in the billing report.

properties -> (list)

The properties.

(structure)

Information about a property.

name -> (string)

The property name.

value -> (string)

The property value.

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.