AWS IoT Device SDK C++ v2  1.43.1
AWS IoT Device SDK C++ v2
Public Member Functions | List of all members
Aws::Iotcommands::IClientV2 Class Referenceabstract

#include <IotCommandsClientV2.h>

Inheritance diagram for Aws::Iotcommands::IClientV2:
Aws::Iotcommands::ClientV2

Public Member Functions

virtual ~IClientV2 ()=default
 
virtual bool UpdateCommandExecution (const UpdateCommandExecutionRequest &request, const UpdateCommandExecutionResultHandler &handler)=0
 
virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperationCreateCommandExecutionsCborPayloadStream (const CommandExecutionsSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< CommandExecutionEvent > &options)=0
 
virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperationCreateCommandExecutionsGenericPayloadStream (const CommandExecutionsSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< CommandExecutionEvent > &options)=0
 
virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperationCreateCommandExecutionsJsonPayloadStream (const CommandExecutionsSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< CommandExecutionEvent > &options)=0
 

Detailed Description

The AWS IoT commands service is used to send an instruction from the cloud to a device that is connected to AWS IoT.

https://docs.aws.amazon.com/iot/latest/developerguide/iot-remote-command.html

Constructor & Destructor Documentation

◆ ~IClientV2()

virtual Aws::Iotcommands::IClientV2::~IClientV2 ( )
virtualdefault

Member Function Documentation

◆ CreateCommandExecutionsCborPayloadStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotcommands::IClientV2::CreateCommandExecutionsCborPayloadStream ( const CommandExecutionsSubscriptionRequest request,
const Aws::Iot::RequestResponse::StreamingOperationOptions< CommandExecutionEvent > &  options 
)
pure virtual

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

Parameters
requestModeled streaming operation subscription configuration.
optionsConfiguration 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::Iotcommands::ClientV2.

◆ CreateCommandExecutionsGenericPayloadStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotcommands::IClientV2::CreateCommandExecutionsGenericPayloadStream ( const CommandExecutionsSubscriptionRequest request,
const Aws::Iot::RequestResponse::StreamingOperationOptions< CommandExecutionEvent > &  options 
)
pure virtual

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

Parameters
requestModeled streaming operation subscription configuration.
optionsConfiguration 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::Iotcommands::ClientV2.

◆ CreateCommandExecutionsJsonPayloadStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotcommands::IClientV2::CreateCommandExecutionsJsonPayloadStream ( const CommandExecutionsSubscriptionRequest request,
const Aws::Iot::RequestResponse::StreamingOperationOptions< CommandExecutionEvent > &  options 
)
pure virtual

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

Parameters
requestModeled streaming operation subscription configuration.
optionsConfiguration 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::Iotcommands::ClientV2.

◆ UpdateCommandExecution()

virtual bool Aws::Iotcommands::IClientV2::UpdateCommandExecution ( const UpdateCommandExecutionRequest request,
const UpdateCommandExecutionResultHandler handler 
)
pure virtual

Update the status of a command execution.

Parameters
requestoperation to perform
handlerfunction object to invoke upon operation completion
Returns
success/failure

Implemented in Aws::Iotcommands::ClientV2.


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