Contents

IoTJobsDataPlaneClient Class

(QtAws::IoTJobsDataPlane::IoTJobsDataPlaneClient)

The IoTJobsDataPlaneClient class provides access to the AWS IoT Jobs Data Plane service. More...

Header: #include <IoTJobsDataPlaneClient>
Inherits: QtAws::Core::AwsAbstractClient

Public Functions

IoTJobsDataPlaneClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
IoTJobsDataPlaneClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Public Slots

DescribeJobExecutionResponse *describeJobExecution(const DescribeJobExecutionRequest &request)
GetPendingJobExecutionsResponse *getPendingJobExecutions(const GetPendingJobExecutionsRequest &request)
StartNextPendingJobExecutionResponse *startNextPendingJobExecution(const StartNextPendingJobExecutionRequest &request)
UpdateJobExecutionResponse *updateJobExecution(const UpdateJobExecutionRequest &request)

Additional Inherited Members

Detailed Description

The IoTJobsDataPlaneClient class provides access to the AWS IoT Jobs Data Plane service.

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

Member Function Documentation

IoTJobsDataPlaneClient::IoTJobsDataPlaneClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a IoTJobsDataPlaneClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

IoTJobsDataPlaneClient::IoTJobsDataPlaneClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads IoTJobsDataPlaneClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] DescribeJobExecutionResponse *IoTJobsDataPlaneClient::describeJobExecution(const DescribeJobExecutionRequest &request)

Sends request to the IoTJobsDataPlaneClient service, and returns a pointer to an DescribeJobExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Gets details of a job

[slot] GetPendingJobExecutionsResponse *IoTJobsDataPlaneClient::getPendingJobExecutions(const GetPendingJobExecutionsRequest &request)

Sends request to the IoTJobsDataPlaneClient service, and returns a pointer to an GetPendingJobExecutionsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] StartNextPendingJobExecutionResponse *IoTJobsDataPlaneClient::startNextPendingJobExecution(const StartNextPendingJobExecutionRequest &request)

Sends request to the IoTJobsDataPlaneClient service, and returns a pointer to an StartNextPendingJobExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

[slot] UpdateJobExecutionResponse *IoTJobsDataPlaneClient::updateJobExecution(const UpdateJobExecutionRequest &request)

Sends request to the IoTJobsDataPlaneClient service, and returns a pointer to an UpdateJobExecutionResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Updates the status of a job

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.