EC2 / Client / get_host_reservation_purchase_preview

get_host_reservation_purchase_preview#

EC2.Client.get_host_reservation_purchase_preview(**kwargs)#

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

Request Syntax

response = client.get_host_reservation_purchase_preview(
    HostIdSet=[
        'string',
    ],
    OfferingId='string'
)
Parameters:

  • HostIdSet (list) –

    [REQUIRED]

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

    • (string) –

  • OfferingId (string) –

    [REQUIRED]

    The offering ID of the reservation.

Return type:

dict

Returns:

Response Syntax

{
    'CurrencyCode': 'USD',
    'Purchase': [
        {
            'CurrencyCode': 'USD',
            'Duration': 123,
            'HostIdSet': [
                'string',
            ],
            'HostReservationId': 'string',
            'HourlyPrice': 'string',
            'InstanceFamily': 'string',
            'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
            'UpfrontPrice': 'string'
        },
    ],
    'TotalHourlyPrice': 'string',
    'TotalUpfrontPrice': 'string'
}

Response Structure

  • (dict) –

    • 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.

      • (dict) –

        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.