Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . savingsplans ]

describe-savings-plans-offerings

Description

Describes the offerings for the specified Savings Plans.

See also: AWS API Documentation

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 <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 types.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  Compute
  EC2Instance
  SageMaker

--durations (list)

The duration, 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 Amazon Web Services operation for the line item in the billing report.

(string)

Syntax:

"string" "string" ...

--filters (list)

The filters.

(structure)

Information about a Savings Plan offering 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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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 Amazon Web Services operation for the line item in the billing report.

properties -> (list)

The properties.

(structure)

Information about a Savings Plan offering 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.