Jobs device MQTT and HTTPS API operations and data types - Amazon IoT Core
Jobs device MQTT and HTTPS data types
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 (PDF).

Jobs device MQTT and HTTPS API operations and data types

The following commands are available over the MQTT and HTTPS protocols. Use these API operations on the data plane for devices executing the jobs.

Jobs device MQTT and HTTPS data types

The following data types are used to communicate with the Amazon IoT Jobs service over the MQTT and HTTPS protocols.

The JobExecution object represents the execution of a job on a device. The following example shows the syntax:

Note

When you use the MQTT and HTTP data plane API operations, the JobExecution data type contains a JobDocument field. Your devices can use this information to retrieve the job document from a job execution.

{
    "jobId" : "string",
    "thingName" : "string",
    "jobDocument" : "string",
    "status": "QUEUED|IN_PROGRESS|FAILED|SUCCEEDED|CANCELED|TIMED_OUT|REJECTED|REMOVED",
    "statusDetails": {
        "string": "string"
    },
    "queuedAt" : "timestamp",
    "startedAt" : "timestamp",
    "lastUpdatedAt" : "timestamp",
    "versionNumber" : "number",
    "executionNumber": long
}

For more information, see JobExecution or job-execution.

The JobExecutionState contains information about the state of a job execution. The following example shows the syntax:

{
    "status": "QUEUED|IN_PROGRESS|FAILED|SUCCEEDED|CANCELED|TIMED_OUT|REJECTED|REMOVED",
    "statusDetails": {
        "string": "string"
        ...
    }
    "versionNumber": "number"
}

For more information, see JobExecutionState or job-execution-state.

Contains a subset of information about a job execution. The following example shows the syntax:

{
    "jobId": "string",
    "queuedAt": timestamp,
    "startedAt": timestamp,
    "lastUpdatedAt": timestamp,
    "versionNumber": "number",
    "executionNumber": long 
}

For more information, see JobExecutionSummary or job-execution-summary.

Learn more about the MQTT and HTTPS API operations in the following sections: