PurchaseReservedInstanceOffering
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
Request Syntax
POST /2021-01-01/opensearch/purchaseReservedInstanceOffering HTTP/1.1
Content-type: application/json
{
"InstanceCount": number,
"ReservationName": "string",
"ReservedInstanceOfferingId": "string"
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- InstanceCount
-
The number of OpenSearch instances to reserve.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- ReservationName
-
A customer-specified identifier to track this reservation.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 64.
Pattern:
.*Required: Yes
- ReservedInstanceOfferingId
-
The ID of the Reserved Instance offering to purchase.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"ReservationName": "string",
"ReservedInstanceId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ReservationName
-
The customer-specified identifier used to track this reservation.
Type: String
Length Constraints: Minimum length of 5. Maximum length of 64.
Pattern:
.* - ReservedInstanceId
-
The ID of the Reserved Instance offering that was purchased.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
\p{XDigit}{8}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{4}-\p{XDigit}{12}
Errors
For information about the errors that are common to all actions, see Common Errors.
- DisabledOperationException
-
An error occured because the client wanted to access an unsupported operation.
HTTP Status Code: 409
- InternalException
-
Request processing failed because of an unknown error, exception, or internal failure.
HTTP Status Code: 500
- LimitExceededException
-
An exception for trying to create more than the allowed number of resources or sub-resources.
HTTP Status Code: 409
- ResourceAlreadyExistsException
-
An exception for creating a resource that already exists.
HTTP Status Code: 409
- ResourceNotFoundException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 409
- ValidationException
-
An exception for accessing or deleting a resource that doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
