Jobs device MQTT and HTTPS API operations and data types - AWS IoT Core
Jobs device MQTT and HTTPS data types

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 AWS IoT Jobs service over the MQTT and HTTPS protocols.

Contains data about a job execution. The following example shows the syntax:

{
    "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.

Contains data 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: