Skip to content

Describe Host Reservation Offerings

ec2_describe_host_reservation_offerings R Documentation

Describes the Dedicated Host reservations that are available to purchase

Description

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.

Usage

ec2_describe_host_reservation_offerings(Filter, MaxDuration, MaxResults,
  MinDuration, NextToken, OfferingId)

Arguments

Filter

The filters.

  • instance-family - The instance family of the offering (for example, m4).

  • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

MaxDuration

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

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

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

The token to use to retrieve the next page of results.

OfferingId

The ID of the reservation offering.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  OfferingSet = list(
    list(
      CurrencyCode = "USD",
      Duration = 123,
      HourlyPrice = "string",
      InstanceFamily = "string",
      OfferingId = "string",
      PaymentOption = "AllUpfront"|"PartialUpfront"|"NoUpfront",
      UpfrontPrice = "string"
    )
  )
)

Request syntax

svc$describe_host_reservation_offerings(
  Filter = list(
    list(
      Name = "string",
      Values = list(
        "string"
      )
    )
  ),
  MaxDuration = 123,
  MaxResults = 123,
  MinDuration = 123,
  NextToken = "string",
  OfferingId = "string"
)