Aws::Iotjobs::ClientV2 Class Reference

Inheritance diagram for Aws::Iotjobs::ClientV2:

Public Member Functions
	ClientV2 (Aws::Crt::Allocator *allocator, std::shared_ptr< Aws::Iot::RequestResponse::IMqttRequestResponseClient > bindingClient)
virtual	~ClientV2 ()=default
bool	DescribeJobExecution (const DescribeJobExecutionRequest &request, const DescribeJobExecutionResultHandler &handler) override
bool	GetPendingJobExecutions (const GetPendingJobExecutionsRequest &request, const GetPendingJobExecutionsResultHandler &handler) override
bool	StartNextPendingJobExecution (const StartNextPendingJobExecutionRequest &request, const StartNextPendingJobExecutionResultHandler &handler) override
bool	UpdateJobExecution (const UpdateJobExecutionRequest &request, const UpdateJobExecutionResultHandler &handler) override
std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateJobExecutionsChangedStream (const JobExecutionsChangedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< JobExecutionsChangedEvent > &options) override
std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateNextJobExecutionChangedStream (const NextJobExecutionChangedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< NextJobExecutionChangedEvent > &options) override
Public Member Functions inherited from Aws::Iotjobs::IClientV2
virtual	~IClientV2 ()=default

Constructor & Destructor Documentation

ClientV2()

Aws::Iotjobs::ClientV2::ClientV2	(	Aws::Crt::Allocator *	allocator,
		std::shared_ptr< Aws::Iot::RequestResponse::IMqttRequestResponseClient >	bindingClient
	)

~ClientV2()

virtual Aws::Iotjobs::ClientV2::~ClientV2 ( )

virtualdefault

Member Function Documentation

CreateJobExecutionsChangedStream()

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

overridevirtual

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.

Implements Aws::Iotjobs::IClientV2.

CreateNextJobExecutionChangedStream()

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

overridevirtual

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.

Implements Aws::Iotjobs::IClientV2.

DescribeJobExecution()

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

overridevirtual

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

Implements Aws::Iotjobs::IClientV2.

GetPendingJobExecutions()

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

overridevirtual

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

Implements Aws::Iotjobs::IClientV2.

StartNextPendingJobExecution()

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

overridevirtual

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

Implements Aws::Iotjobs::IClientV2.

UpdateJobExecution()

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

overridevirtual

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

Implements Aws::Iotjobs::IClientV2.

---

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

• jobs/source/IotJobsClientV2.cpp