host_reservation_offerings

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

Overview

Name	host_reservation_offerings
Type	Resource
Id	aws.ec2.host_reservation_offerings

Fields

The following fields are returned by SELECT queries:

describe_host_reservation_offerings

Name	Datatype	Description
currency_code	string	The currency of the offering.
duration	integer	The duration of the offering (in seconds).
hourly_price	string	The hourly price of the offering.
instance_family	string	The instance family of the offering.
offering_id	string	The ID of the offering.
payment_option	string	The available payment option.
upfront_price	string	The upfront price of the offering. Does not apply to No Upfront offerings.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_host_reservation_offerings	select	region	Filter, MaxDuration, MaxResults, MinDuration, NextToken, OfferingId	Describes the Dedicated Host reservations that are available to purchase. The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.

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)
Filter	array	The filters. instance-family - The instance family of the offering (for example, m4). payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
MaxDuration	integer	This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
MaxResults	integer	The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
MinDuration	integer	This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
NextToken	string	The token to use to retrieve the next page of results.
OfferingId	string	The ID of the reservation offering.

SELECT examples

describe_host_reservation_offerings

Describes the Dedicated Host reservations that are available to purchase. The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.

SELECT
currency_code,
duration,
hourly_price,
instance_family,
offering_id,
payment_option,
upfront_price
FROM aws.ec2.host_reservation_offerings
WHERE region = '{{ region }}' -- required
AND Filter = '{{ Filter }}'
AND MaxDuration = '{{ MaxDuration }}'
AND MaxResults = '{{ MaxResults }}'
AND MinDuration = '{{ MinDuration }}'
AND NextToken = '{{ NextToken }}'
AND OfferingId = '{{ OfferingId }}'
;