Purchase Reserved Instances Offering

ec2_purchase_reserved_instances_offering

R Documentation

Purchases a Reserved Instance for use with your account¶

Description¶

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 describe_reserved_instances_offerings 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 describe_reserved_instances.

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.

Usage¶

ec2_purchase_reserved_instances_offering(InstanceCount,
  ReservedInstancesOfferingId, PurchaseTime, DryRun, LimitPrice)

Arguments¶

InstanceCount

[required] The number of Reserved Instances to purchase.

ReservedInstancesOfferingId

[required] The ID of the Reserved Instance offering to purchase.

PurchaseTime

The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).

DryRun

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

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

Value¶

A list with the following syntax:

list(
  ReservedInstancesId = "string"
)

Request syntax¶

svc$purchase_reserved_instances_offering(
  InstanceCount = 123,
  ReservedInstancesOfferingId = "string",
  PurchaseTime = as.POSIXct(
    "2015-01-01"
  ),
  DryRun = TRUE|FALSE,
  LimitPrice = list(
    Amount = 123.0,
    CurrencyCode = "USD"
  )
)