Amazonka.IoTJobsData.StartNextPendingJobExecution

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

Creating a Request

data StartNextPendingJobExecution

See: newStartNextPendingJobExecution smart constructor.

Constructors

StartNextPendingJobExecution'

Fields

• 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.

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

• thingName :: Text

  The name of the thing associated with the device.

Instances

ToJSON StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

toJSON :: StartNextPendingJobExecution -> Value

toEncoding :: StartNextPendingJobExecution -> Encoding

toJSONList :: [StartNextPendingJobExecution] -> Value

toEncodingList :: [StartNextPendingJobExecution] -> Encoding

ToHeaders StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

toHeaders :: StartNextPendingJobExecution -> [Header]

ToPath StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

toPath :: StartNextPendingJobExecution -> ByteString

ToQuery StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

toQuery :: StartNextPendingJobExecution -> QueryString

AWSRequest StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Associated Types

type AWSResponse StartNextPendingJobExecution

Methods

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

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

Generic StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Associated Types

type Rep StartNextPendingJobExecution :: Type -> Type

Methods

from :: StartNextPendingJobExecution -> Rep StartNextPendingJobExecution x

to :: Rep StartNextPendingJobExecution x -> StartNextPendingJobExecution

Read StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

readsPrec :: Int -> ReadS StartNextPendingJobExecution

readList :: ReadS [StartNextPendingJobExecution]

readPrec :: ReadPrec StartNextPendingJobExecution

readListPrec :: ReadPrec [StartNextPendingJobExecution]

Show StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

showsPrec :: Int -> StartNextPendingJobExecution -> ShowS

show :: StartNextPendingJobExecution -> String

showList :: [StartNextPendingJobExecution] -> ShowS

NFData StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

rnf :: StartNextPendingJobExecution -> ()

Eq StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

(==) :: StartNextPendingJobExecution -> StartNextPendingJobExecution -> Bool

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

Hashable StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

hashWithSalt :: Int -> StartNextPendingJobExecution -> Int

hash :: StartNextPendingJobExecution -> Int

type AWSResponse StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type AWSResponse StartNextPendingJobExecution = StartNextPendingJobExecutionResponse

type Rep StartNextPendingJobExecution

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type Rep StartNextPendingJobExecution = D1 ('MetaData "StartNextPendingJobExecution" "Amazonka.IoTJobsData.StartNextPendingJobExecution" "amazonka-iot-jobs-dataplane-2.0-8C3LLBSYBtOF7RBF3JFCku" 'False) (C1 ('MetaCons "StartNextPendingJobExecution'" 'PrefixI 'True) (S1 ('MetaSel ('Just "statusDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "stepTimeoutInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartNextPendingJobExecution

Arguments

:: Text

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:

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

StartNextPendingJobExecution, startNextPendingJobExecution_thingName - The name of the thing associated with the device.

Request Lenses

startNextPendingJobExecution_statusDetails :: Lens' StartNextPendingJobExecution (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.

startNextPendingJobExecution_stepTimeoutInMinutes :: Lens' StartNextPendingJobExecution (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).

startNextPendingJobExecution_thingName :: Lens' StartNextPendingJobExecution Text

The name of the thing associated with the device.

Destructuring the Response

data StartNextPendingJobExecutionResponse

See: newStartNextPendingJobExecutionResponse smart constructor.

Constructors

StartNextPendingJobExecutionResponse'

Fields

• execution :: Maybe JobExecution

  A JobExecution object.

• httpStatus :: Int

  The response's http status code.

Instances

Generic StartNextPendingJobExecutionResponse

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Associated Types

type Rep StartNextPendingJobExecutionResponse :: Type -> Type

Methods

from :: StartNextPendingJobExecutionResponse -> Rep StartNextPendingJobExecutionResponse x

to :: Rep StartNextPendingJobExecutionResponse x -> StartNextPendingJobExecutionResponse

Read StartNextPendingJobExecutionResponse

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

readsPrec :: Int -> ReadS StartNextPendingJobExecutionResponse

readList :: ReadS [StartNextPendingJobExecutionResponse]

readPrec :: ReadPrec StartNextPendingJobExecutionResponse

readListPrec :: ReadPrec [StartNextPendingJobExecutionResponse]

Show StartNextPendingJobExecutionResponse

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

showsPrec :: Int -> StartNextPendingJobExecutionResponse -> ShowS

show :: StartNextPendingJobExecutionResponse -> String

showList :: [StartNextPendingJobExecutionResponse] -> ShowS

NFData StartNextPendingJobExecutionResponse

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

rnf :: StartNextPendingJobExecutionResponse -> ()

Eq StartNextPendingJobExecutionResponse

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

Methods

(==) :: StartNextPendingJobExecutionResponse -> StartNextPendingJobExecutionResponse -> Bool

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

type Rep StartNextPendingJobExecutionResponse

Defined in Amazonka.IoTJobsData.StartNextPendingJobExecution

type Rep StartNextPendingJobExecutionResponse = D1 ('MetaData "StartNextPendingJobExecutionResponse" "Amazonka.IoTJobsData.StartNextPendingJobExecution" "amazonka-iot-jobs-dataplane-2.0-8C3LLBSYBtOF7RBF3JFCku" '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

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)

A JobExecution object.

startNextPendingJobExecutionResponse_httpStatus :: Lens' StartNextPendingJobExecutionResponse Int

The response's http status code.