Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeReservedInstances

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Request Syntax


GET /2021-01-01/opensearch/reservedInstances?maxResults=MaxResults&nextToken=NextToken&reservationId=ReservedInstanceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

Valid Range: Maximum value of 100.

NextToken

If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

ReservedInstanceId

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

Length Constraints: Fixed length of 36.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "ReservedInstances": [ 
      { 
         "BillingSubscriptionId": number,
         "CurrencyCode": "string",
         "Duration": number,
         "FixedPrice": number,
         "InstanceCount": number,
         "InstanceType": "string",
         "PaymentOption": "string",
         "RecurringCharges": [ 
            { 
               "RecurringChargeAmount": number,
               "RecurringChargeFrequency": "string"
            }
         ],
         "ReservationName": "string",
         "ReservedInstanceId": "string",
         "ReservedInstanceOfferingId": "string",
         "StartTime": number,
         "State": "string",
         "UsagePrice": number
      }
   ]
}

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.

NextToken

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

Type: String

ReservedInstances

List of Reserved Instances in the current Region.

Type: Array of ReservedInstance objects

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

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