| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.EC2.RunScheduledInstances
Description
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. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
Synopsis
- data RunScheduledInstances = RunScheduledInstances' {}
- newRunScheduledInstances :: ScheduledInstancesLaunchSpecification -> Text -> RunScheduledInstances
- runScheduledInstances_clientToken :: Lens' RunScheduledInstances (Maybe Text)
- runScheduledInstances_dryRun :: Lens' RunScheduledInstances (Maybe Bool)
- runScheduledInstances_instanceCount :: Lens' RunScheduledInstances (Maybe Int)
- runScheduledInstances_launchSpecification :: Lens' RunScheduledInstances ScheduledInstancesLaunchSpecification
- runScheduledInstances_scheduledInstanceId :: Lens' RunScheduledInstances Text
- data RunScheduledInstancesResponse = RunScheduledInstancesResponse' {
- instanceIdSet :: Maybe [Text]
- httpStatus :: Int
- newRunScheduledInstancesResponse :: Int -> RunScheduledInstancesResponse
- runScheduledInstancesResponse_instanceIdSet :: Lens' RunScheduledInstancesResponse (Maybe [Text])
- runScheduledInstancesResponse_httpStatus :: Lens' RunScheduledInstancesResponse Int
Creating a Request
data RunScheduledInstances Source #
Contains the parameters for RunScheduledInstances.
See: newRunScheduledInstances smart constructor.
Constructors
| RunScheduledInstances' | |
Fields
| |
Instances
newRunScheduledInstances Source #
Arguments
| :: ScheduledInstancesLaunchSpecification | |
| -> Text | |
| -> RunScheduledInstances |
Create a value of RunScheduledInstances with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RunScheduledInstances, runScheduledInstances_clientToken - Unique, case-sensitive identifier that ensures the idempotency of the
request. For more information, see
Ensuring Idempotency.
$sel:dryRun:RunScheduledInstances', runScheduledInstances_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.
RunScheduledInstances, runScheduledInstances_instanceCount - The number of instances.
Default: 1
RunScheduledInstances, runScheduledInstances_launchSpecification - The launch specification. You must match the instance type, Availability
Zone, network, and platform of the schedule that you purchased.
RunScheduledInstances, runScheduledInstances_scheduledInstanceId - The Scheduled Instance ID.
Request Lenses
runScheduledInstances_clientToken :: Lens' RunScheduledInstances (Maybe Text) Source #
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.
runScheduledInstances_dryRun :: Lens' RunScheduledInstances (Maybe Bool) Source #
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.
runScheduledInstances_instanceCount :: Lens' RunScheduledInstances (Maybe Int) Source #
The number of instances.
Default: 1
runScheduledInstances_launchSpecification :: Lens' RunScheduledInstances ScheduledInstancesLaunchSpecification Source #
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.
runScheduledInstances_scheduledInstanceId :: Lens' RunScheduledInstances Text Source #
The Scheduled Instance ID.
Destructuring the Response
data RunScheduledInstancesResponse Source #
Contains the output of RunScheduledInstances.
See: newRunScheduledInstancesResponse smart constructor.
Constructors
| RunScheduledInstancesResponse' | |
Fields
| |
Instances
newRunScheduledInstancesResponse Source #
Create a value of RunScheduledInstancesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceIdSet:RunScheduledInstancesResponse', runScheduledInstancesResponse_instanceIdSet - The IDs of the newly launched instances.
$sel:httpStatus:RunScheduledInstancesResponse', runScheduledInstancesResponse_httpStatus - The response's http status code.
Response Lenses
runScheduledInstancesResponse_instanceIdSet :: Lens' RunScheduledInstancesResponse (Maybe [Text]) Source #
The IDs of the newly launched instances.
runScheduledInstancesResponse_httpStatus :: Lens' RunScheduledInstancesResponse Int Source #
The response's http status code.