/2015-01-01/es/reservedInstanceOfferings - Amazon Elasticsearch Service

Lists available reserved Elasticsearch instance offerings.

Request

Query Params

offeringId

string

optional

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

maxResults

integer

optional

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

nextToken

string

optional

NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

MaxResults

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Responses

🟢200Success

application/json

Body

Container for results from <code>DescribeReservedElasticsearchInstanceOfferings</code>

NextToken

string

optional

Provides an identifier to allow retrieval of paginated results.

ReservedElasticsearchInstanceOfferings

array[object (ReservedElasticsearchInstanceOffering) {8}]

optional

List of reserved Elasticsearch instance offerings

ReservedElasticsearchInstanceOfferingId

string

optional

The Elasticsearch reserved instance offering identifier.

Match pattern:

\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}

ElasticsearchInstanceType

enum<string>

optional

The Elasticsearch instance type offered by the reserved instance offering.

Allowed values:

m3.medium.elasticsearchm3.large.elasticsearchm3.xlarge.elasticsearchm3.2xlarge.elasticsearchm4.large.elasticsearchm4.xlarge.elasticsearchm4.2xlarge.elasticsearchm4.4xlarge.elasticsearchm4.10xlarge.elasticsearchm5.large.elasticsearchm5.xlarge.elasticsearchm5.2xlarge.elasticsearchm5.4xlarge.elasticsearchm5.12xlarge.elasticsearchr5.large.elasticsearchr5.xlarge.elasticsearchr5.2xlarge.elasticsearchr5.4xlarge.elasticsearchr5.12xlarge.elasticsearchc5.large.elasticsearchc5.xlarge.elasticsearchc5.2xlarge.elasticsearchc5.4xlarge.elasticsearchc5.9xlarge.elasticsearchc5.18xlarge.elasticsearchultrawarm1.medium.elasticsearchultrawarm1.large.elasticsearcht2.micro.elasticsearcht2.small.elasticsearcht2.medium.elasticsearchr3.large.elasticsearchr3.xlarge.elasticsearchr3.2xlarge.elasticsearchr3.4xlarge.elasticsearchr3.8xlarge.elasticsearchi2.xlarge.elasticsearchi2.2xlarge.elasticsearchd2.xlarge.elasticsearchd2.2xlarge.elasticsearchd2.4xlarge.elasticsearchd2.8xlarge.elasticsearchc4.large.elasticsearchc4.xlarge.elasticsearchc4.2xlarge.elasticsearchc4.4xlarge.elasticsearchc4.8xlarge.elasticsearchr4.large.elasticsearchr4.xlarge.elasticsearchr4.2xlarge.elasticsearchr4.4xlarge.elasticsearchr4.8xlarge.elasticsearchr4.16xlarge.elasticsearchi3.large.elasticsearchi3.xlarge.elasticsearchi3.2xlarge.elasticsearchi3.4xlarge.elasticsearchi3.8xlarge.elasticsearchi3.16xlarge.elasticsearch

Duration

integer

optional

The duration, in seconds, for which the offering will reserve the Elasticsearch instance.

FixedPrice

number <double>

optional

The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.

UsagePrice

number <double>

optional

The rate you are charged for each hour the domain that is using the offering is running.

CurrencyCode

string

optional

The currency code for the reserved Elasticsearch instance offering.

PaymentOption

enum<string>

optional

Payment option for the reserved Elasticsearch instance offering

Allowed values:

ALL_UPFRONTPARTIAL_UPFRONTNO_UPFRONT

RecurringCharges

array[object (RecurringCharge) {2}]

optional

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

🟠480ResourceNotFoundException

🟠481ValidationException

🟠482DisabledOperationException

🟠483InternalException