Aws::Iotjobs::IClientV2 Class Reference

#include <IotJobsClientV2.h>

Inheritance diagram for Aws::Iotjobs::IClientV2:

Public Member Functions
virtual	~IClientV2 ()=default
virtual bool	DescribeJobExecution (const DescribeJobExecutionRequest &request, const DescribeJobExecutionResultHandler &handler)=0
virtual bool	GetPendingJobExecutions (const GetPendingJobExecutionsRequest &request, const GetPendingJobExecutionsResultHandler &handler)=0
virtual bool	StartNextPendingJobExecution (const StartNextPendingJobExecutionRequest &request, const StartNextPendingJobExecutionResultHandler &handler)=0
virtual bool	UpdateJobExecution (const UpdateJobExecutionRequest &request, const UpdateJobExecutionResultHandler &handler)=0
virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateJobExecutionsChangedStream (const JobExecutionsChangedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< JobExecutionsChangedEvent > &options)=0
virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateNextJobExecutionChangedStream (const NextJobExecutionChangedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< NextJobExecutionChangedEvent > &options)=0

Detailed Description

The AWS IoT jobs service can be used to define a set of remote operations that are sent to and executed on one or more devices connected to AWS IoT.

https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#jobs-mqtt-api

Constructor & Destructor Documentation

~IClientV2()

virtual Aws::Iotjobs::IClientV2::~IClientV2 ( )

virtualdefault

Member Function Documentation

CreateJobExecutionsChangedStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotjobs::IClientV2::CreateJobExecutionsChangedStream ( const JobExecutionsChangedSubscriptionRequest &  request, const Aws::Iot::RequestResponse::StreamingOperationOptions< JobExecutionsChangedEvent > &  options  )

pure virtual

Creates a stream of JobExecutionsChanged notifications for a given IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-jobexecutionschanged

Parameters

request	Modeled streaming operation subscription configuration.
options	Configuration options for the streaming operation.

Returns

A streaming operation which will emit a modeled event every time a message is received on the associated MQTT topic.

Implemented in Aws::Iotjobs::ClientV2.

CreateNextJobExecutionChangedStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotjobs::IClientV2::CreateNextJobExecutionChangedStream ( const NextJobExecutionChangedSubscriptionRequest &  request, const Aws::Iot::RequestResponse::StreamingOperationOptions< NextJobExecutionChangedEvent > &  options  )

pure virtual

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-nextjobexecutionchanged

Parameters

request	Modeled streaming operation subscription configuration.
options	Configuration options for the streaming operation.

Returns

A streaming operation which will emit a modeled event every time a message is received on the associated MQTT topic.

Implemented in Aws::Iotjobs::ClientV2.

DescribeJobExecution()

virtual bool Aws::Iotjobs::IClientV2::DescribeJobExecution ( const DescribeJobExecutionRequest &  request, const DescribeJobExecutionResultHandler &  handler  )

pure virtual

Gets detailed information about a job execution.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-describejobexecution

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implemented in Aws::Iotjobs::ClientV2.

GetPendingJobExecutions()

virtual bool Aws::Iotjobs::IClientV2::GetPendingJobExecutions ( const GetPendingJobExecutionsRequest &  request, const GetPendingJobExecutionsResultHandler &  handler  )

pure virtual

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

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-getpendingjobexecutions

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implemented in Aws::Iotjobs::ClientV2.

StartNextPendingJobExecution()

virtual bool Aws::Iotjobs::IClientV2::StartNextPendingJobExecution ( const StartNextPendingJobExecutionRequest &  request, const StartNextPendingJobExecutionResultHandler &  handler  )

pure virtual

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

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-startnextpendingjobexecution

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implemented in Aws::Iotjobs::ClientV2.

UpdateJobExecution()

virtual bool Aws::Iotjobs::IClientV2::UpdateJobExecution ( const UpdateJobExecutionRequest &  request, const UpdateJobExecutionResultHandler &  handler  )

pure virtual

Updates the status of a job execution. You can optionally create a step timer by setting a value for the stepTimeoutInMinutes property. If you don't update the value of this property by running UpdateJobExecution again, the job execution times out when the step timer expires.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/jobs-api.html#mqtt-updatejobexecution

Parameters

request	operation to perform
handler	function object to invoke upon operation completion

Returns

success/failure

Implemented in Aws::Iotjobs::ClientV2.

---

The documentation for this class was generated from the following file:

• jobs/include/aws/iotjobs/IotJobsClientV2.h