reserved_instance_offerings

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

Overview

Name	reserved_instance_offerings
Type	Resource
Id	aws.opensearch.reserved_instance_offerings

Fields

The following fields are returned by SELECT queries:

describe_reserved_instance_offerings

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_instance_offerings	array	List of Reserved Instance offerings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_instance_offerings	select	region	offeringId, maxResults, nextToken	Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
purchase_reserved_instance_offering	exec	region, ReservedInstanceOfferingId, ReservationName		Allows you to purchase Amazon OpenSearch Service Reserved Instances.

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 DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
offeringId	string	The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

SELECT examples

describe_reserved_instance_offerings

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

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

Lifecycle Methods

purchase_reserved_instance_offering

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

EXEC aws.opensearch.reserved_instance_offerings.purchase_reserved_instance_offering 
@region='{{ region }}' --required 
@@json=
'{
"ReservedInstanceOfferingId": "{{ ReservedInstanceOfferingId }}", 
"ReservationName": "{{ ReservationName }}", 
"InstanceCount": {{ InstanceCount }}
}'
;