ec2_purchase_host_reservation {aws.ecx}

Purchase Host Reservation

Description

Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.

Usage

ec2_purchase_host_reservation(
  HostIdSet,
  OfferingId,
  ClientToken = NULL,
  CurrencyCode = NULL,
  LimitPrice = NULL,
  TagSpecification = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

HostIdSet

List. The IDs of the Dedicated Hosts with which the reservation will be associated.

OfferingId

Character. The ID of the offering.

ClientToken

Character. Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.[optional]

CurrencyCode

Character. The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified....[optional]

LimitPrice

Character. The specified limit is checked against the total upfront cost of the reservation (calculated as the offering\'s upfront cost multiplied by the host count)....[optional]

TagSpecification

List. The tags to apply to the Dedicated Host Reservation during purchase.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

HostIdSet

The IDs of the Dedicated Hosts with which the reservation will be associated.

OfferingId

The ID of the offering.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

CurrencyCode

The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.

LimitPrice

The specified limit is checked against the total upfront cost of the reservation (calculated as the offering\'s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.

TagSpecification

The tags to apply to the Dedicated Host Reservation during purchase.