View Source AWS.IoTJobsDataPlane (aws-elixir v1.0.4)

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

Link to this section Summary

Functions

describe_job_execution(client, job_id, thing_name, execution_number \\ nil, include_job_document \\ nil, options \\ [])

Gets details of a job execution.

get_pending_job_executions(client, thing_name, options \\ [])

Gets the list of all jobs for a thing that are not in a terminal status.

metadata()

start_command_execution(client, input, options \\ [])

Using the command created with the CreateCommand API, start a command execution on a specific device.

start_next_pending_job_execution(client, thing_name, input, options \\ [])

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

update_job_execution(client, job_id, thing_name, input, options \\ [])

Updates the status of a job execution.

Link to this section Functions

describe_job_execution(client, job_id, thing_name, execution_number \\ nil, include_job_document \\ nil, options \\ [])

Gets details of a job execution.

Requires permission to access the DescribeJobExecution action.

get_pending_job_executions(client, thing_name, options \\ [])

Gets the list of all jobs for a thing that are not in a terminal status.

Requires permission to access the GetPendingJobExecutions action.

metadata()

start_command_execution(client, input, options \\ [])

Using the command created with the CreateCommand API, start a command execution on a specific device.

start_next_pending_job_execution(client, thing_name, input, options \\ [])

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Requires permission to access the StartNextPendingJobExecution action.

update_job_execution(client, job_id, thing_name, input, options \\ [])

Updates the status of a job execution.

Requires permission to access the UpdateJobExecution action.