Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTJobsData.StartNextPendingJobExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Synopsis

Creating a Request

data StartNextPendingJobExecution Source #

See: newStartNextPendingJobExecution smart constructor.

Constructors

StartNextPendingJobExecution'

Fields

stepTimeoutInMinutes :: Maybe Integer
Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).
statusDetails :: Maybe (HashMap Text Text)
A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
thingName :: Text
The name of the thing associated with the device.

Instances

Instances details

Eq StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods (==) :: StartNextPendingJobExecution -> StartNextPendingJobExecution -> Bool # (/=) :: StartNextPendingJobExecution -> StartNextPendingJobExecution -> Bool #
Read StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods readsPrec :: Int -> ReadS StartNextPendingJobExecution # readList :: ReadS [StartNextPendingJobExecution] # readPrec :: ReadPrec StartNextPendingJobExecution # readListPrec :: ReadPrec [StartNextPendingJobExecution] #
Show StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods showsPrec :: Int -> StartNextPendingJobExecution -> ShowS # show :: StartNextPendingJobExecution -> String # showList :: [StartNextPendingJobExecution] -> ShowS #
Generic StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Associated Types type Rep StartNextPendingJobExecution :: Type -> Type # Methods from :: StartNextPendingJobExecution -> Rep StartNextPendingJobExecution x # to :: Rep StartNextPendingJobExecution x -> StartNextPendingJobExecution #
NFData StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods rnf :: StartNextPendingJobExecution -> () #
Hashable StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods hashWithSalt :: Int -> StartNextPendingJobExecution -> Int # hash :: StartNextPendingJobExecution -> Int #
ToJSON StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods toJSON :: StartNextPendingJobExecution -> Value # toEncoding :: StartNextPendingJobExecution -> Encoding # toJSONList :: [StartNextPendingJobExecution] -> Value # toEncodingList :: [StartNextPendingJobExecution] -> Encoding #
AWSRequest StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Associated Types type AWSResponse StartNextPendingJobExecution # Methods request :: StartNextPendingJobExecution -> Request StartNextPendingJobExecution # response :: MonadResource m => Logger -> Service -> Proxy StartNextPendingJobExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartNextPendingJobExecution))) #
ToHeaders StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods toHeaders :: StartNextPendingJobExecution -> [Header] #
ToPath StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods toPath :: StartNextPendingJobExecution -> ByteString #
ToQuery StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods toQuery :: StartNextPendingJobExecution -> QueryString #
type Rep StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution type Rep StartNextPendingJobExecution = D1 ('MetaData "StartNextPendingJobExecution" "Amazonka.IoTJobsData.StartNextPendingJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "StartNextPendingJobExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stepTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartNextPendingJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution type AWSResponse StartNextPendingJobExecution = StartNextPendingJobExecutionResponse

newStartNextPendingJobExecution Source #

Arguments

:: Text	`$sel:thingName:StartNextPendingJobExecution'`
-> StartNextPendingJobExecution

Create a value of StartNextPendingJobExecution 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:stepTimeoutInMinutes:StartNextPendingJobExecution', startNextPendingJobExecution_stepTimeoutInMinutes - Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

$sel:statusDetails:StartNextPendingJobExecution', startNextPendingJobExecution_statusDetails - A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

$sel:thingName:StartNextPendingJobExecution', startNextPendingJobExecution_thingName - The name of the thing associated with the device.

Request Lenses

startNextPendingJobExecution_stepTimeoutInMinutes :: Lens' StartNextPendingJobExecution (Maybe Integer) Source #

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

startNextPendingJobExecution_statusDetails :: Lens' StartNextPendingJobExecution (Maybe (HashMap Text Text)) Source #

A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

startNextPendingJobExecution_thingName :: Lens' StartNextPendingJobExecution Text Source #

The name of the thing associated with the device.

Destructuring the Response

data StartNextPendingJobExecutionResponse Source #

See: newStartNextPendingJobExecutionResponse smart constructor.

Constructors

StartNextPendingJobExecutionResponse'
Fields execution :: Maybe JobExecution A JobExecution object. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StartNextPendingJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods (==) :: StartNextPendingJobExecutionResponse -> StartNextPendingJobExecutionResponse -> Bool # (/=) :: StartNextPendingJobExecutionResponse -> StartNextPendingJobExecutionResponse -> Bool #
Read StartNextPendingJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods readsPrec :: Int -> ReadS StartNextPendingJobExecutionResponse # readList :: ReadS [StartNextPendingJobExecutionResponse] # readPrec :: ReadPrec StartNextPendingJobExecutionResponse # readListPrec :: ReadPrec [StartNextPendingJobExecutionResponse] #
Show StartNextPendingJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods showsPrec :: Int -> StartNextPendingJobExecutionResponse -> ShowS # show :: StartNextPendingJobExecutionResponse -> String # showList :: [StartNextPendingJobExecutionResponse] -> ShowS #
Generic StartNextPendingJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Associated Types type Rep StartNextPendingJobExecutionResponse :: Type -> Type # Methods from :: StartNextPendingJobExecutionResponse -> Rep StartNextPendingJobExecutionResponse x # to :: Rep StartNextPendingJobExecutionResponse x -> StartNextPendingJobExecutionResponse #
NFData StartNextPendingJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution Methods rnf :: StartNextPendingJobExecutionResponse -> () #
type Rep StartNextPendingJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution type Rep StartNextPendingJobExecutionResponse = D1 ('MetaData "StartNextPendingJobExecutionResponse" "Amazonka.IoTJobsData.StartNextPendingJobExecution" "libZSservicesZSamazonka-iot-jobs-dataplaneZSamazonka-iot-jobs-dataplane" 'False) (C1 ('MetaCons "StartNextPendingJobExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "execution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecution)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartNextPendingJobExecutionResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartNextPendingJobExecutionResponse'`
-> StartNextPendingJobExecutionResponse

Create a value of StartNextPendingJobExecutionResponse 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:execution:StartNextPendingJobExecutionResponse', startNextPendingJobExecutionResponse_execution - A JobExecution object.

$sel:httpStatus:StartNextPendingJobExecutionResponse', startNextPendingJobExecutionResponse_httpStatus - The response's http status code.

Response Lenses

startNextPendingJobExecutionResponse_execution :: Lens' StartNextPendingJobExecutionResponse (Maybe JobExecution) Source #

A JobExecution object.

startNextPendingJobExecutionResponse_httpStatus :: Lens' StartNextPendingJobExecutionResponse Int Source #

The response's http status code.