#include <IotShadowClientV2.h>

Inheritance diagram for Aws::Iotshadow::IClientV2:

Public Member Functions
virtual	~IClientV2 ()=default

virtual bool	DeleteNamedShadow (const DeleteNamedShadowRequest &request, const DeleteNamedShadowResultHandler &handler)=0

virtual bool	DeleteShadow (const DeleteShadowRequest &request, const DeleteShadowResultHandler &handler)=0

virtual bool	GetNamedShadow (const GetNamedShadowRequest &request, const GetNamedShadowResultHandler &handler)=0

virtual bool	GetShadow (const GetShadowRequest &request, const GetShadowResultHandler &handler)=0

virtual bool	UpdateNamedShadow (const UpdateNamedShadowRequest &request, const UpdateNamedShadowResultHandler &handler)=0

virtual bool	UpdateShadow (const UpdateShadowRequest &request, const UpdateShadowResultHandler &handler)=0

virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateNamedShadowDeltaUpdatedStream (const NamedShadowDeltaUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > &options)=0

virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateNamedShadowUpdatedStream (const NamedShadowUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > &options)=0

virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateShadowDeltaUpdatedStream (const ShadowDeltaUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > &options)=0

virtual std::shared_ptr< Aws::Iot::RequestResponse::IStreamingOperation >	CreateShadowUpdatedStream (const ShadowUpdatedSubscriptionRequest &request, const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > &options)=0

Detailed Description

The AWS IoT Device Shadow service adds shadows to AWS IoT thing objects. Shadows are a simple data store for device properties and state. Shadows can make a device’s state available to apps and other services whether the device is connected to AWS IoT or not.

https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html

Constructor & Destructor Documentation

◆ ~IClientV2()

virtual Aws::Iotshadow::IClientV2::~IClientV2 ( )

virtualdefault

Member Function Documentation

◆ CreateNamedShadowDeltaUpdatedStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotshadow::IClientV2::CreateNamedShadowDeltaUpdatedStream	(	const NamedShadowDeltaUpdatedSubscriptionRequest &	request,
		const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > &	options
	)

pure virtual

Create a stream for NamedShadowDelta events for a named shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

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::Iotshadow::ClientV2.

◆ CreateNamedShadowUpdatedStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotshadow::IClientV2::CreateNamedShadowUpdatedStream	(	const NamedShadowUpdatedSubscriptionRequest &	request,
		const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > &	options
	)

pure virtual

Create a stream for ShadowUpdated events for a named shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

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::Iotshadow::ClientV2.

◆ CreateShadowDeltaUpdatedStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotshadow::IClientV2::CreateShadowDeltaUpdatedStream	(	const ShadowDeltaUpdatedSubscriptionRequest &	request,
		const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowDeltaUpdatedEvent > &	options
	)

pure virtual

Create a stream for ShadowDelta events for the (classic) shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-delta-pub-sub-topic

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::Iotshadow::ClientV2.

◆ CreateShadowUpdatedStream()

virtual std::shared_ptr<Aws::Iot::RequestResponse::IStreamingOperation> Aws::Iotshadow::IClientV2::CreateShadowUpdatedStream	(	const ShadowUpdatedSubscriptionRequest &	request,
		const Aws::Iot::RequestResponse::StreamingOperationOptions< ShadowUpdatedEvent > &	options
	)

pure virtual

Create a stream for ShadowUpdated events for the (classic) shadow of an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-documents-pub-sub-topic

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::Iotshadow::ClientV2.

◆ DeleteNamedShadow()

virtual bool Aws::Iotshadow::IClientV2::DeleteNamedShadow	(	const DeleteNamedShadowRequest &	request,
		const DeleteNamedShadowResultHandler &	handler
	)

pure virtual

Deletes a named shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

Parameters

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

Returns: success/failure

Implemented in Aws::Iotshadow::ClientV2.

◆ DeleteShadow()

virtual bool Aws::Iotshadow::IClientV2::DeleteShadow	(	const DeleteShadowRequest &	request,
		const DeleteShadowResultHandler &	handler
	)

pure virtual

Deletes the (classic) shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#delete-pub-sub-topic

Parameters

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

Returns: success/failure

Implemented in Aws::Iotshadow::ClientV2.

◆ GetNamedShadow()

virtual bool Aws::Iotshadow::IClientV2::GetNamedShadow	(	const GetNamedShadowRequest &	request,
		const GetNamedShadowResultHandler &	handler
	)

pure virtual

Gets a named shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

Parameters

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

Returns: success/failure

Implemented in Aws::Iotshadow::ClientV2.

◆ GetShadow()

virtual bool Aws::Iotshadow::IClientV2::GetShadow	(	const GetShadowRequest &	request,
		const GetShadowResultHandler &	handler
	)

pure virtual

Gets the (classic) shadow for an AWS IoT thing.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#get-pub-sub-topic

Parameters

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

Returns: success/failure

Implemented in Aws::Iotshadow::ClientV2.

◆ UpdateNamedShadow()

virtual bool Aws::Iotshadow::IClientV2::UpdateNamedShadow	(	const UpdateNamedShadowRequest &	request,
		const UpdateNamedShadowResultHandler &	handler
	)

pure virtual

Update a named shadow for a device.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

Parameters

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

Returns: success/failure

Implemented in Aws::Iotshadow::ClientV2.

◆ UpdateShadow()

virtual bool Aws::Iotshadow::IClientV2::UpdateShadow	(	const UpdateShadowRequest &	request,
		const UpdateShadowResultHandler &	handler
	)

pure virtual

Update a device's (classic) shadow.

AWS documentation: https://docs.aws.amazon.com/iot/latest/developerguide/device-shadow-mqtt.html#update-pub-sub-topic

Parameters

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

Returns: success/failure

Implemented in Aws::Iotshadow::ClientV2.

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

shadow/include/aws/iotshadow/IotShadowClientV2.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IClientV2()

Member Function Documentation

◆ CreateNamedShadowDeltaUpdatedStream()

◆ CreateNamedShadowUpdatedStream()

◆ CreateShadowDeltaUpdatedStream()

◆ CreateShadowUpdatedStream()

◆ DeleteNamedShadow()

◆ DeleteShadow()

◆ GetNamedShadow()

◆ GetShadow()

◆ UpdateNamedShadow()

◆ UpdateShadow()