Menu
AWS IoT
API Reference

JobExecution

Contains data about a job execution.

Contents

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 milliseconds since the epoch, when the job execution was last updated.

Type: Long

Required: No

queuedAt

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

Type: Long

Required: No

startedAt

The time, in milliseconds 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", "REJECTED", or "REMOVED".

Type: String

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

Required: No

statusDetails

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

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. Maximum length of 1024.

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

On this page: