reserved_instances

Creates, updates, deletes, gets or lists a reserved_instances resource.

Overview

Name	reserved_instances
Type	Resource
Id	aws.opensearch.reserved_instances

Fields

The following fields are returned by SELECT queries:

describe_reserved_instances

Name	Datatype	Description
next_token	string	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.
reserved_instances	array	List of Reserved Instances in the current Region.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_instances	select	region	reservationId, maxResults, nextToken	Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
maxResults	integer	An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken	string	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.
reservationId	string	The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.

SELECT examples

describe_reserved_instances

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

SELECT
next_token,
reserved_instances
FROM aws.opensearch.reserved_instances
WHERE region = '{{ region }}' -- required
AND reservationId = '{{ reservationId }}'
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;