-ExecutionNumber <Int64>
Optional. A number that identifies a particular job execution on a particular device.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-ExpectedVersion <Int64>
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.)
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Optional. When set to true, the response contains the job document. The default is false.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-IncludeJobExecutionState <
Boolean>
Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The unique identifier assigned to this job when it was created.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTJobsDataPlane.Model.UpdateJobExecutionResponse). Specifying the name of a property of type Amazon.IoTJobsDataPlane.Model.UpdateJobExecutionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StatusDetails |
-StepTimeoutInMinute <Int64>
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
).
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StepTimeoutInMinutes |
The name of the thing associated with the device.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |