describe-reserved-elasticsearch-instances¶

Description¶

Returns information about reserved Elasticsearch instances for this account.

Synopsis¶

  describe-reserved-elasticsearch-instances
[--reserved-elasticsearch-instance-id <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--reserved-elasticsearch-instance-id (string)

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

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To view all reserved instances

The following describe-elasticsearch-domains example provides a summary of all instances you have reserved in a region.

aws es describe-reserved-elasticsearch-instances

Output:

{
    "ReservedElasticsearchInstances": [{
        "FixedPrice": 100.0,
        "ReservedElasticsearchInstanceOfferingId": "1a2a3a4a5-1a2a-3a4a-5a6a-1a2a3a4a5a6a",
        "ReservationName": "my-reservation",
        "PaymentOption": "PARTIAL_UPFRONT",
        "UsagePrice": 0.0,
        "ReservedElasticsearchInstanceId": "9a8a7a6a-5a4a-3a2a-1a0a-9a8a7a6a5a4a",
        "RecurringCharges": [{
            "RecurringChargeAmount": 0.603,
            "RecurringChargeFrequency": "Hourly"
        }],
        "State": "payment-pending",
        "StartTime": 1522872571.229,
        "ElasticsearchInstanceCount": 3,
        "Duration": 31536000,
        "ElasticsearchInstanceType": "m4.2xlarge.elasticsearch",
        "CurrencyCode": "USD"
    }]
}

For more information, see Reserved Instances in the Amazon Elasticsearch Service Developer Guide.

Output¶

NextToken -> (string)

Provides an identifier to allow retrieval of paginated results.

ReservedElasticsearchInstances -> (list)

List of reserved Elasticsearch instances.

(structure)

Details of a reserved Elasticsearch instance.

ReservationName -> (string)

The customer-specified identifier to track this reservation.

ReservedElasticsearchInstanceId -> (string)

The unique identifier for the reservation.

ReservedElasticsearchInstanceOfferingId -> (string)

The offering identifier.

ElasticsearchInstanceType -> (string)

The Elasticsearch instance type offered by the reserved instance offering.

StartTime -> (timestamp)

The time the reservation started.

Duration -> (integer)

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

FixedPrice -> (double)

The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch 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 Elasticsearch instance offering.

ElasticsearchInstanceCount -> (integer)

The number of Elasticsearch instances that have been reserved.

State -> (string)

The state of the reserved Elasticsearch instance.

PaymentOption -> (string)

The payment option as defined in the reserved Elasticsearch 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 Elasticsearch instance, or for a reserved Elasticsearch instance offering.

RecurringChargeAmount -> (double)

The monetary amount of the recurring charge.

RecurringChargeFrequency -> (string)

The frequency of the recurring charge.

Table of Contents

Feedback

User Guide