Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
Updates the status of a job execution.
- updateJobExecution :: Text -> Text -> JobExecutionStatus -> UpdateJobExecution
- data UpdateJobExecution
- ujeIncludeJobDocument :: Lens' UpdateJobExecution (Maybe Bool)
- ujeStatusDetails :: Lens' UpdateJobExecution (HashMap Text Text)
- ujeExecutionNumber :: Lens' UpdateJobExecution (Maybe Integer)
- ujeExpectedVersion :: Lens' UpdateJobExecution (Maybe Integer)
- ujeIncludeJobExecutionState :: Lens' UpdateJobExecution (Maybe Bool)
- ujeJobId :: Lens' UpdateJobExecution Text
- ujeThingName :: Lens' UpdateJobExecution Text
- ujeStatus :: Lens' UpdateJobExecution JobExecutionStatus
- updateJobExecutionResponse :: Int -> UpdateJobExecutionResponse
- data UpdateJobExecutionResponse
- ujersJobDocument :: Lens' UpdateJobExecutionResponse (Maybe Text)
- ujersExecutionState :: Lens' UpdateJobExecutionResponse (Maybe JobExecutionState)
- ujersResponseStatus :: Lens' UpdateJobExecutionResponse Int
Creating a Request
Creates a value of UpdateJobExecution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ujeIncludeJobDocument
- Optional. When set to true, the response contains the job document. The default is false.ujeStatusDetails
- Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.ujeExecutionNumber
- Optional. A number that identifies a particular job execution on a particular device.ujeExpectedVersion
- 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.)ujeIncludeJobExecutionState
- Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.ujeJobId
- The unique identifier assigned to this job when it was created.ujeThingName
- The name of the thing associated with the device.ujeStatus
- The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
data UpdateJobExecution Source #
See: updateJobExecution
smart constructor.
Request Lenses
ujeIncludeJobDocument :: Lens' UpdateJobExecution (Maybe Bool) Source #
Optional. When set to true, the response contains the job document. The default is false.
ujeStatusDetails :: Lens' UpdateJobExecution (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.
ujeExecutionNumber :: Lens' UpdateJobExecution (Maybe Integer) Source #
Optional. A number that identifies a particular job execution on a particular device.
ujeExpectedVersion :: 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.)
ujeIncludeJobExecutionState :: Lens' UpdateJobExecution (Maybe Bool) Source #
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
ujeJobId :: Lens' UpdateJobExecution Text Source #
The unique identifier assigned to this job when it was created.
ujeThingName :: Lens' UpdateJobExecution Text Source #
The name of the thing associated with the device.
ujeStatus :: 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
updateJobExecutionResponse Source #
Creates a value of UpdateJobExecutionResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ujersJobDocument
- The contents of the Job Documents.ujersExecutionState
- A JobExecutionState object.ujersResponseStatus
- -- | The response status code.
data UpdateJobExecutionResponse Source #
See: updateJobExecutionResponse
smart constructor.
Response Lenses
ujersJobDocument :: Lens' UpdateJobExecutionResponse (Maybe Text) Source #
The contents of the Job Documents.
ujersExecutionState :: Lens' UpdateJobExecutionResponse (Maybe JobExecutionState) Source #
A JobExecutionState object.
ujersResponseStatus :: Lens' UpdateJobExecutionResponse Int Source #
- - | The response status code.