Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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

describe-reserved-instances

Description

Returns information about reserved OpenSearch instances for this account.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-reserved-instances
[--reserved-instance-id <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--reserved-instance-id (string)

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

--max-results (integer)

Set this value to limit the number of results returned. If not specified, defaults to 100.

--next-token (string)

Provides an identifier to allow retrieval of paginated results.

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

See 'aws help' for descriptions of global parameters.

Output

NextToken -> (string)

Provides an identifier to allow retrieval of paginated results.

ReservedInstances -> (list)

List of reserved OpenSearch instances.

(structure)

Details of a reserved OpenSearch instance.

ReservationName -> (string)

The customer-specified identifier to track this reservation.

ReservedInstanceId -> (string)

The unique identifier for the reservation.

BillingSubscriptionId -> (long)

ReservedInstanceOfferingId -> (string)

The offering identifier.

InstanceType -> (string)

The OpenSearch instance type offered by the reserved instance offering.

StartTime -> (timestamp)

The time the reservation started.

Duration -> (integer)

The duration, in seconds, for which the OpenSearch instance is reserved.

FixedPrice -> (double)

The upfront fixed charge you will paid to purchase the specific reserved OpenSearch instance offering.

UsagePrice -> (double)

The rate you are charged for each hour for the domain that is using this reserved instance.

CurrencyCode -> (string)

The currency code for the reserved OpenSearch instance offering.

InstanceCount -> (integer)

The number of OpenSearch instances that have been reserved.

State -> (string)

The state of the reserved OpenSearch instance.

PaymentOption -> (string)

The payment option as defined in the reserved OpenSearch instance offering.

RecurringCharges -> (list)

The charge to your account regardless of whether you are creating any domains using the instance offering.

(structure)

Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.

RecurringChargeAmount -> (double)

The monetary amount of the recurring charge.

RecurringChargeFrequency -> (string)

The frequency of the recurring charge.