RunScheduledInstances
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes.
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 isUnauthorizedOperation.Type: Boolean
Required: No
- InstanceCount
-
The number of instances.
Default: 1
Type: Integer
Required: No
- LaunchSpecification
-
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
Type: ScheduledInstancesLaunchSpecification object
Required: Yes
- ScheduledInstanceId
-
The Scheduled Instance ID.
Type: String
Required: Yes
Response Elements
The following elements are returned by the service.
- instanceIdSet
-
The IDs of the newly launched instances.
Type: Array of strings
- requestId
-
The ID of the request.
Type: String
Errors
For information about the errors that are common to all actions, see Common client error codes.
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
