Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

PurchaseScheduledInstances

Purchases one or more Scheduled Instances with the specified schedule.

Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call DescribeScheduledInstanceAvailability to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call RunScheduledInstances during each scheduled time period.

After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.

Type: String

Required: No

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.

Type: Boolean

Required: No

PurchaseRequest.N

One or more purchase requests.

Type: Array of PurchaseRequest objects

Array Members: Minimum number of 1 item.

Required: Yes

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

scheduledInstanceSet

Information about the Scheduled Instances.

Type: Array of ScheduledInstance objects

Errors

For information about the errors that are common to all actions, see Common Client Errors.

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: