[ aws . ec2 ]

get-host-reservation-purchase-preview

Description

Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation.

This is a preview of the PurchaseHostReservation action and does not result in the offering being purchased.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-host-reservation-purchase-preview
--host-id-set <value>
--offering-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--host-id-set (list)

The IDs of the Dedicated Hosts with which the reservation is associated.

(string)

Syntax:

"string" "string" ...

--offering-id (string)

The offering ID of the reservation.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get a purchase preview for a Dedicated Host Reservation

This example provides a preview of the costs for a specified Dedicated Host Reservation for the specified Dedicated Host in your account.

Command:

aws ec2 get-host-reservation-purchase-preview --offering-id hro-03f707bf363b6b324 --host-id-set h-013abcd2a00cbd123

Output:

{
  "TotalHourlyPrice": "1.499",
  "Purchase": [
      {
          "HourlyPrice": "1.499",
          "InstanceFamily": "m4",
          "PaymentOption": "NoUpfront",
          "HostIdSet": [
              "h-013abcd2a00cbd123"
          ],
          "UpfrontPrice": "0.000",
          "Duration": 31536000
      }
  ],
  "TotalUpfrontPrice": "0.000"
}

Output

CurrencyCode -> (string)

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

Purchase -> (list)

The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.

(structure)

Describes the result of the purchase.

CurrencyCode -> (string)

The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD .

Duration -> (integer)

The duration of the reservation’s term in seconds.

HostIdSet -> (list)

The IDs of the Dedicated Hosts associated with the reservation.

(string)

HostReservationId -> (string)

The ID of the reservation.

HourlyPrice -> (string)

The hourly price of the reservation per hour.

InstanceFamily -> (string)

The instance family on the Dedicated Host that the reservation can be associated with.

PaymentOption -> (string)

The payment option for the reservation.

UpfrontPrice -> (string)

The upfront price of the reservation.

TotalHourlyPrice -> (string)

The potential total hourly price of the reservation per hour.

TotalUpfrontPrice -> (string)

The potential total upfront price. This is billed immediately.