/2015-01-01/es/purchaseReservedInstanceOffering

The Amazon Elasticsearch Service multi-region endpoint

http://es.{region}.amazonaws.com

POST

Allows you to purchase reserved Elasticsearch instances.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://es.{region}.amazonaws.com/2015-01-01/es/purchaseReservedInstanceOffering' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ReservedElasticsearchInstanceOfferingId": "string",
    "ReservationName": "string",
    "InstanceCount": 1
}'

Response Example

200 - Example 1

{
    "ReservedElasticsearchInstanceId": "string",
    "ReservationName": "string"
}

Request

Body Params application/json

ReservedElasticsearchInstanceOfferingId

string

required

The ID of the reserved Elasticsearch instance offering to purchase.

Match pattern:

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

ReservationName

string

required

A customer-specified identifier to track this reservation.

>= 5 characters<= 64 characters

InstanceCount

integer

optional

Specifies the number of EC2 instances in the Elasticsearch domain.

>= 1

Examples

Responses

🟢200Success

application/json

Body

Represents the output of a <code>PurchaseReservedElasticsearchInstanceOffering</code> operation.

ReservedElasticsearchInstanceId

string

optional

Details of the reserved Elasticsearch instance which was purchased.

Match pattern:

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

ReservationName

string

optional

The customer-specified identifier used to track this reservation.

>= 5 characters<= 64 characters

🟠480ResourceNotFoundException

🟠481ResourceAlreadyExistsException

🟠482LimitExceededException

🟠483DisabledOperationException

🟠484ValidationException

🟠485InternalException

/2015-01-01/es/domain/{DomainName}/vpcEndpoints

/2015-01-01/es/ccs/inboundConnection/{ConnectionId}/reject