Amazonka.EC2.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. For more information, see Scheduled Instances in the Amazon EC2 User Guide.

Creating a Request

data RunScheduledInstances

Contains the parameters for RunScheduledInstances.

See: newRunScheduledInstances smart constructor.

Constructors

RunScheduledInstances'

Fields

• clientToken :: Maybe Text

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

• dryRun :: Maybe Bool

  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.

• instanceCount :: Maybe Int

  The number of instances.

  Default: 1

• launchSpecification :: ScheduledInstancesLaunchSpecification

  The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.

• scheduledInstanceId :: Text

  The Scheduled Instance ID.

Instances

ToHeaders RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

toHeaders :: RunScheduledInstances -> [Header]

ToPath RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

toPath :: RunScheduledInstances -> ByteString

ToQuery RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

toQuery :: RunScheduledInstances -> QueryString

AWSRequest RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Associated Types

type AWSResponse RunScheduledInstances

Methods

request :: (Service -> Service) -> RunScheduledInstances -> Request RunScheduledInstances

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RunScheduledInstances -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RunScheduledInstances)))

Generic RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Associated Types

type Rep RunScheduledInstances :: Type -> Type

Methods

from :: RunScheduledInstances -> Rep RunScheduledInstances x

to :: Rep RunScheduledInstances x -> RunScheduledInstances

Read RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

readsPrec :: Int -> ReadS RunScheduledInstances

readList :: ReadS [RunScheduledInstances]

readPrec :: ReadPrec RunScheduledInstances

readListPrec :: ReadPrec [RunScheduledInstances]

Show RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

showsPrec :: Int -> RunScheduledInstances -> ShowS

show :: RunScheduledInstances -> String

showList :: [RunScheduledInstances] -> ShowS

NFData RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

rnf :: RunScheduledInstances -> ()

Eq RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

(==) :: RunScheduledInstances -> RunScheduledInstances -> Bool

(/=) :: RunScheduledInstances -> RunScheduledInstances -> Bool

Hashable RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

Methods

hashWithSalt :: Int -> RunScheduledInstances -> Int

hash :: RunScheduledInstances -> Int

type AWSResponse RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

type AWSResponse RunScheduledInstances = RunScheduledInstancesResponse

type Rep RunScheduledInstances

Defined in Amazonka.EC2.RunScheduledInstances

type Rep RunScheduledInstances = D1 ('MetaData "RunScheduledInstances" "Amazonka.EC2.RunScheduledInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RunScheduledInstances'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "instanceCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "launchSpecification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ScheduledInstancesLaunchSpecification) :*: S1 ('MetaSel ('Just "scheduledInstanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newRunScheduledInstances

Arguments

:: ScheduledInstancesLaunchSpecification

RunScheduledInstances

-> Text

RunScheduledInstances

-> 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)

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

runScheduledInstances_dryRun :: Lens' RunScheduledInstances (Maybe Bool)

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)

The number of instances.

Default: 1

runScheduledInstances_launchSpecification :: Lens' RunScheduledInstances ScheduledInstancesLaunchSpecification

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

The Scheduled Instance ID.

Destructuring the Response

data RunScheduledInstancesResponse

Contains the output of RunScheduledInstances.

See: newRunScheduledInstancesResponse smart constructor.

Constructors

RunScheduledInstancesResponse'

Fields

• instanceIdSet :: Maybe [Text]

  The IDs of the newly launched instances.

• httpStatus :: Int

  The response's http status code.

Instances

Generic RunScheduledInstancesResponse

Defined in Amazonka.EC2.RunScheduledInstances

Associated Types

type Rep RunScheduledInstancesResponse :: Type -> Type

Methods

from :: RunScheduledInstancesResponse -> Rep RunScheduledInstancesResponse x

to :: Rep RunScheduledInstancesResponse x -> RunScheduledInstancesResponse

Read RunScheduledInstancesResponse

Defined in Amazonka.EC2.RunScheduledInstances

Methods

readsPrec :: Int -> ReadS RunScheduledInstancesResponse

readList :: ReadS [RunScheduledInstancesResponse]

readPrec :: ReadPrec RunScheduledInstancesResponse

readListPrec :: ReadPrec [RunScheduledInstancesResponse]

Show RunScheduledInstancesResponse

Defined in Amazonka.EC2.RunScheduledInstances

Methods

showsPrec :: Int -> RunScheduledInstancesResponse -> ShowS

show :: RunScheduledInstancesResponse -> String

showList :: [RunScheduledInstancesResponse] -> ShowS

NFData RunScheduledInstancesResponse

Defined in Amazonka.EC2.RunScheduledInstances

Methods

rnf :: RunScheduledInstancesResponse -> ()

Eq RunScheduledInstancesResponse

Defined in Amazonka.EC2.RunScheduledInstances

Methods

(==) :: RunScheduledInstancesResponse -> RunScheduledInstancesResponse -> Bool

(/=) :: RunScheduledInstancesResponse -> RunScheduledInstancesResponse -> Bool

type Rep RunScheduledInstancesResponse

Defined in Amazonka.EC2.RunScheduledInstances

type Rep RunScheduledInstancesResponse = D1 ('MetaData "RunScheduledInstancesResponse" "Amazonka.EC2.RunScheduledInstances" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "RunScheduledInstancesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceIdSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRunScheduledInstancesResponse

Arguments

:: Int

$sel:httpStatus:RunScheduledInstancesResponse'

-> RunScheduledInstancesResponse

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])

The IDs of the newly launched instances.

runScheduledInstancesResponse_httpStatus :: Lens' RunScheduledInstancesResponse Int

The response's http status code.