IoTJobsDataPlane class

AWS 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 AWS IoT. 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.

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.

AWS 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 AWS IoT. The Jobs service provides commands to track the progress of a job on a specific target and for all the targets of the job


IoTJobsDataPlane({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})


hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited


close() → void
Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
describeJobExecution({required String jobId, required String thingName, int? executionNumber, bool? includeJobDocument}) Future<DescribeJobExecutionResponse>
Gets details of a job execution.
getPendingJobExecutions({required String thingName}) Future<GetPendingJobExecutionsResponse>
Gets the list of all jobs for a thing that are not in a terminal status.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
startNextPendingJobExecution({required String thingName, Map<String, String>? statusDetails, int? stepTimeoutInMinutes}) Future<StartNextPendingJobExecutionResponse>
Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.
toString() String
A string representation of this object.
updateJobExecution({required String jobId, required JobExecutionStatus status, required String thingName, int? executionNumber, int? expectedVersion, bool? includeJobDocument, bool? includeJobExecutionState, Map<String, String>? statusDetails, int? stepTimeoutInMinutes}) Future<UpdateJobExecutionResponse>
Updates the status of a job execution.


operator ==(Object other) bool
The equality operator.