JobExecution - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

JobExecution

Contains data about a job execution.

Contents

approximateSecondsBeforeTimedOut

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The actual job execution timeout can occur up to 60 seconds later than the estimated duration.

Type: Long

Required: No

executionNumber

A number that identifies a particular job execution on a particular device. It can be used later in commands that return or update job execution information.

Type: Long

Required: No

jobDocument

The content of the job document.

Type: String

Length Constraints: Maximum length of 32768.

Required: No

jobId

The unique identifier you assigned to this 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: Long

Required: No

queuedAt

The time, in seconds since the epoch, when the job execution was enqueued.

Type: Long

Required: No

startedAt

The time, in seconds since the epoch, when the job execution was started.

Type: Long

Required: No

status

The status of the job execution. Can be one of: "QUEUED", "IN_PROGRESS", "FAILED", "SUCCESS", "CANCELED", "TIMED_OUT", "REJECTED", or "REMOVED".

Type: String

Valid Values: QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT | REJECTED | REMOVED | CANCELED

Required: No

statusDetails

A collection of name/value pairs that describe the status of the job execution.

The maximum length of the value in the name/value pair is 1,024 characters.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9:_-]+

Value Length Constraints: Minimum length of 1.

Value Pattern: [^\p{C}]+

Required: No

thingName

The name of the thing that is executing the job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

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 Amazon SDKs, see the following: