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.IoTJobsData.UpdateJobExecution

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the status of a job execution.

Synopsis

data UpdateJobExecution = UpdateJobExecution' {
- executionNumber :: Maybe Integer
- expectedVersion :: Maybe Integer
- includeJobDocument :: Maybe Bool
- includeJobExecutionState :: Maybe Bool
- statusDetails :: Maybe (HashMap Text Text)
- stepTimeoutInMinutes :: Maybe Integer
- jobId :: Text
- thingName :: Text
- status :: JobExecutionStatus
}
newUpdateJobExecution :: Text -> Text -> JobExecutionStatus -> UpdateJobExecution
updateJobExecution_executionNumber :: Lens' UpdateJobExecution (Maybe Integer)
updateJobExecution_expectedVersion :: Lens' UpdateJobExecution (Maybe Integer)
updateJobExecution_includeJobDocument :: Lens' UpdateJobExecution (Maybe Bool)
updateJobExecution_includeJobExecutionState :: Lens' UpdateJobExecution (Maybe Bool)
updateJobExecution_statusDetails :: Lens' UpdateJobExecution (Maybe (HashMap Text Text))
updateJobExecution_stepTimeoutInMinutes :: Lens' UpdateJobExecution (Maybe Integer)
updateJobExecution_jobId :: Lens' UpdateJobExecution Text
updateJobExecution_thingName :: Lens' UpdateJobExecution Text
updateJobExecution_status :: Lens' UpdateJobExecution JobExecutionStatus
data UpdateJobExecutionResponse = UpdateJobExecutionResponse' {
- executionState :: Maybe JobExecutionState
- jobDocument :: Maybe Text
- httpStatus :: Int
}
newUpdateJobExecutionResponse :: Int -> UpdateJobExecutionResponse
updateJobExecutionResponse_executionState :: Lens' UpdateJobExecutionResponse (Maybe JobExecutionState)
updateJobExecutionResponse_jobDocument :: Lens' UpdateJobExecutionResponse (Maybe Text)
updateJobExecutionResponse_httpStatus :: Lens' UpdateJobExecutionResponse Int

Creating a Request

data UpdateJobExecution Source #

See: newUpdateJobExecution smart constructor.

Constructors

UpdateJobExecution'

Fields

executionNumber :: Maybe Integer
Optional. A number that identifies a particular job execution on a particular device.
expectedVersion :: Maybe Integer
Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)
includeJobDocument :: Maybe Bool
Optional. When set to true, the response contains the job document. The default is false.
includeJobExecutionState :: Maybe Bool
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
statusDetails :: Maybe (HashMap Text Text)
Optional. 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 again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).
jobId :: Text
The unique identifier assigned to this job when it was created.
thingName :: Text
The name of the thing associated with the device.
status :: JobExecutionStatus
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Instances

Instances details

ToJSON UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods toJSON :: UpdateJobExecution -> Value # toEncoding :: UpdateJobExecution -> Encoding # toJSONList :: [UpdateJobExecution] -> Value # toEncodingList :: [UpdateJobExecution] -> Encoding #
ToHeaders UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods toHeaders :: UpdateJobExecution -> [Header] #
ToPath UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods toPath :: UpdateJobExecution -> ByteString #
ToQuery UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods toQuery :: UpdateJobExecution -> QueryString #
AWSRequest UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Associated Types type AWSResponse UpdateJobExecution # Methods request :: (Service -> Service) -> UpdateJobExecution -> Request UpdateJobExecution # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateJobExecution -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateJobExecution))) #
Generic UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Associated Types type Rep UpdateJobExecution :: Type -> Type # Methods from :: UpdateJobExecution -> Rep UpdateJobExecution x # to :: Rep UpdateJobExecution x -> UpdateJobExecution #
Read UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods readsPrec :: Int -> ReadS UpdateJobExecution # readList :: ReadS [UpdateJobExecution] # readPrec :: ReadPrec UpdateJobExecution # readListPrec :: ReadPrec [UpdateJobExecution] #
Show UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods showsPrec :: Int -> UpdateJobExecution -> ShowS # show :: UpdateJobExecution -> String # showList :: [UpdateJobExecution] -> ShowS #
NFData UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods rnf :: UpdateJobExecution -> () #
Eq UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods (==) :: UpdateJobExecution -> UpdateJobExecution -> Bool # (/=) :: UpdateJobExecution -> UpdateJobExecution -> Bool #
Hashable UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods hashWithSalt :: Int -> UpdateJobExecution -> Int # hash :: UpdateJobExecution -> Int #
type AWSResponse UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution type AWSResponse UpdateJobExecution = UpdateJobExecutionResponse
type Rep UpdateJobExecution Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution type Rep UpdateJobExecution = D1 ('MetaData "UpdateJobExecution" "Amazonka.IoTJobsData.UpdateJobExecution" "amazonka-iot-jobs-dataplane-2.0-8C3LLBSYBtOF7RBF3JFCku" 'False) (C1 ('MetaCons "UpdateJobExecution'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "executionNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "expectedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))) :: (S1 ('MetaSel ('Just "includeJobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "includeJobExecutionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((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 "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobExecutionStatus))))))

newUpdateJobExecution Source #

Arguments

:: Text	`UpdateJobExecution`
-> Text	`UpdateJobExecution`
-> JobExecutionStatus	`UpdateJobExecution`
-> UpdateJobExecution

Create a value of UpdateJobExecution 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:

UpdateJobExecution, updateJobExecution_executionNumber - Optional. A number that identifies a particular job execution on a particular device.

$sel:expectedVersion:UpdateJobExecution', updateJobExecution_expectedVersion - Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

$sel:includeJobDocument:UpdateJobExecution', updateJobExecution_includeJobDocument - Optional. When set to true, the response contains the job document. The default is false.

$sel:includeJobExecutionState:UpdateJobExecution', updateJobExecution_includeJobExecutionState - Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

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

$sel:stepTimeoutInMinutes:UpdateJobExecution', updateJobExecution_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 again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

UpdateJobExecution, updateJobExecution_jobId - The unique identifier assigned to this job when it was created.

UpdateJobExecution, updateJobExecution_thingName - The name of the thing associated with the device.

UpdateJobExecution, updateJobExecution_status - The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Request Lenses

updateJobExecution_executionNumber :: Lens' UpdateJobExecution (Maybe Integer) Source #

Optional. A number that identifies a particular job execution on a particular device.

updateJobExecution_expectedVersion :: Lens' UpdateJobExecution (Maybe Integer) Source #

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

updateJobExecution_includeJobDocument :: Lens' UpdateJobExecution (Maybe Bool) Source #

Optional. When set to true, the response contains the job document. The default is false.

updateJobExecution_includeJobExecutionState :: Lens' UpdateJobExecution (Maybe Bool) Source #

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

updateJobExecution_statusDetails :: Lens' UpdateJobExecution (Maybe (HashMap Text Text)) Source #

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

updateJobExecution_stepTimeoutInMinutes :: Lens' UpdateJobExecution (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 again calling UpdateJobExecution, setting the status to IN_PROGRESS and specifying a new timeout value in this field) the job execution status will be automatically set to TIMED_OUT. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (CreateJob using field timeoutConfig).

updateJobExecution_jobId :: Lens' UpdateJobExecution Text Source #

The unique identifier assigned to this job when it was created.

updateJobExecution_thingName :: Lens' UpdateJobExecution Text Source #

The name of the thing associated with the device.

updateJobExecution_status :: Lens' UpdateJobExecution JobExecutionStatus Source #

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

Destructuring the Response

data UpdateJobExecutionResponse Source #

See: newUpdateJobExecutionResponse smart constructor.

Constructors

UpdateJobExecutionResponse'
Fields executionState :: Maybe JobExecutionState A JobExecutionState object. jobDocument :: Maybe Text The contents of the Job Documents. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Associated Types type Rep UpdateJobExecutionResponse :: Type -> Type # Methods from :: UpdateJobExecutionResponse -> Rep UpdateJobExecutionResponse x # to :: Rep UpdateJobExecutionResponse x -> UpdateJobExecutionResponse #
Read UpdateJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods readsPrec :: Int -> ReadS UpdateJobExecutionResponse # readList :: ReadS [UpdateJobExecutionResponse] # readPrec :: ReadPrec UpdateJobExecutionResponse # readListPrec :: ReadPrec [UpdateJobExecutionResponse] #
Show UpdateJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods showsPrec :: Int -> UpdateJobExecutionResponse -> ShowS # show :: UpdateJobExecutionResponse -> String # showList :: [UpdateJobExecutionResponse] -> ShowS #
NFData UpdateJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods rnf :: UpdateJobExecutionResponse -> () #
Eq UpdateJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution Methods (==) :: UpdateJobExecutionResponse -> UpdateJobExecutionResponse -> Bool # (/=) :: UpdateJobExecutionResponse -> UpdateJobExecutionResponse -> Bool #
type Rep UpdateJobExecutionResponse Source #
Instance details Defined in Amazonka.IoTJobsData.UpdateJobExecution type Rep UpdateJobExecutionResponse = D1 ('MetaData "UpdateJobExecutionResponse" "Amazonka.IoTJobsData.UpdateJobExecution" "amazonka-iot-jobs-dataplane-2.0-8C3LLBSYBtOF7RBF3JFCku" 'False) (C1 ('MetaCons "UpdateJobExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "executionState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobExecutionState)) :: (S1 ('MetaSel ('Just "jobDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateJobExecutionResponse Source #

Arguments

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

Create a value of UpdateJobExecutionResponse 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:executionState:UpdateJobExecutionResponse', updateJobExecutionResponse_executionState - A JobExecutionState object.

UpdateJobExecutionResponse, updateJobExecutionResponse_jobDocument - The contents of the Job Documents.

$sel:httpStatus:UpdateJobExecutionResponse', updateJobExecutionResponse_httpStatus - The response's http status code.

Response Lenses

updateJobExecutionResponse_executionState :: Lens' UpdateJobExecutionResponse (Maybe JobExecutionState) Source #

A JobExecutionState object.

updateJobExecutionResponse_jobDocument :: Lens' UpdateJobExecutionResponse (Maybe Text) Source #

The contents of the Job Documents.

updateJobExecutionResponse_httpStatus :: Lens' UpdateJobExecutionResponse Int Source #

The response's http status code.