JobExecution
The job execution object represents the execution of a job on a particular device.
Contents
- approximateSecondsBeforeTimedOut
-
The estimated number of seconds that remain before the job execution status will be changed to
TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.Type: Long
Required: No
- executionNumber
-
A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.
Type: Long
Required: No
- forceCanceled
-
Will be
trueif the job execution was canceled with the optionalforceparameter set totrue.Type: Boolean
Required: No
- jobId
-
The unique identifier you assigned to the job when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+Required: No
- lastUpdatedAt
-
The time, in seconds since the epoch, when the job execution was last updated.
Type: Timestamp
Required: No
- queuedAt
-
The time, in seconds since the epoch, when the job execution was queued.
Type: Timestamp
Required: No
- startedAt
-
The time, in seconds since the epoch, when the job execution started.
Type: Timestamp
Required: No
- status
-
The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).
Type: String
Valid Values:
QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT | REJECTED | REMOVED | CANCELEDRequired: No
- statusDetails
-
A collection of name/value pairs that describe the status of the job execution.
Type: JobExecutionStatusDetails object
Required: No
- thingArn
-
The ARN of the thing on which the job execution is running.
Type: String
Required: No
- versionNumber
-
The version of the job execution. Job execution versions are incremented each time they are updated by a device.
Type: Long
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
