Amazon Web Services, Inc.

AWS IoT Jobs Data Plane

IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to Amazon Web…

Data & analytics#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

IoT Jobs is a service that allows you to define a set of jobs — remote operations
that are sent to and executed on one or more devices connected to Amazon Web Services IoT Core. For example,
you can define a job that instructs a set of devices to download and install application or
firmware updates, reboot, rotate certificates, or perform remote troubleshooting
operations.
Find the endpoint address for actions in the IoT jobs data plane by running this
CLI command:

aws iot describe-endpoint --endpoint-type iot:Jobs

The service name used by Amazon Web Services
Signature Version 4 to sign requests is:
iot-jobs-data .
To create a job, you make a job document which is a description of the remote
operations to be performed, and you specify a list of targets that should perform the
operations. The targets can be individual things, thing groups or both.
IoT Jobs sends a message to inform the targets that a job is available. The target
starts the execution of the job by downloading the job document, performing the operations
it specifies, and reporting its progress to Amazon Web Services IoT Core. The Jobs service provides commands
to track the progress of a job on a specific target and for all the targets of the
job

Endpoints 5

  • GETDescribe job execution/things/:thingName/jobs/:jobId?includeJobDocument=true&executionNumber=0Gets details of a job execution. Requires permission to access the DescribeJobExecution action.
  • POSTUpdate job execution/things/:thingName/jobs/:jobIdUpdates the status of a job execution. Requires permission to access the UpdateJobExecution action.
  • GETGet pending job executions/things/:thingName/jobsGets the list of all jobs for a thing that are not in a terminal status. Requires permission to access the GetPendingJobExecutions action.
  • POSTStart command execution/command-executionsUsing the command created with the CreateCommand API, start a command execution on a specific device.
  • PUTStart next pending job execution/things/:thingName/jobs/$nextGets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing. Requires permission to access the StartNextPendingJobExecution…

API details

Base URL
https://data.jobs.iot.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
5 operations on 4 pathsGET 2POST 2PUT 1
Description format
AWS Smithy model, API version 2017-09-29

How to test the AWS IoT Jobs Data Plane in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT Jobs Data Plane collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Describe job execution” (GET /things/:thingName/jobs/:jobId?includeJobDocument=true&executionNumber=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT Jobs Data Plane?

IoT Jobs is a service that allows you to define a set of jobs — remote operations that are sent to and executed on one or more devices connected to Amazon Web… It is listed under Data & analytics and has 5 endpoints.

Who publishes the AWS IoT Jobs Data Plane?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT Jobs Data Plane?

Requests go to https://data.jobs.iot.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT Jobs Data Plane?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT Jobs Data Plane have?

5 operations on 4 paths (2 GET, 2 POST, 1 PUT).

Is forking the AWS IoT Jobs Data Plane free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.