EC2 / Client / purchase_reserved_instances_offering

purchase_reserved_instances_offering#

EC2.Client.purchase_reserved_instances_offering(**kwargs)#

Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.

Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you’ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.

To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.

For more information, see Reserved Instances and Sell in the Reserved Instance Marketplace in the Amazon EC2 User Guide.

See also: AWS API Documentation

Request Syntax

response = client.purchase_reserved_instances_offering(
    InstanceCount=123,
    ReservedInstancesOfferingId='string',
    PurchaseTime=datetime(2015, 1, 1),
    DryRun=True|False,
    LimitPrice={
        'Amount': 123.0,
        'CurrencyCode': 'USD'
    }
)
Parameters:

  • InstanceCount (integer) –

    [REQUIRED]

    The number of Reserved Instances to purchase.

  • ReservedInstancesOfferingId (string) –

    [REQUIRED]

    The ID of the Reserved Instance offering to purchase.

  • PurchaseTime (datetime) – The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DD*T*HH:MM:*SS*Z).

  • DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

  • LimitPrice (dict) –

    Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.

    • Amount (float) –

      Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).

    • CurrencyCode (string) –

      The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.

Return type:

dict

Returns:

Response Syntax

{
    'ReservedInstancesId': 'string'
}

Response Structure

  • (dict) –

    Contains the output of PurchaseReservedInstancesOffering.

    • ReservedInstancesId (string) –

      The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon EC2 User Guide.