/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/iot-data/IoTDataPlane_EXPORTS.h>
#include <aws/core/client/ClientConfiguration.h>
#include <aws/core/client/AWSClient.h>
#include <aws/core/client/AWSClientAsyncCRTP.h>
#include <aws/core/utils/json/JsonSerializer.h>
#include <aws/iot-data/IoTDataPlaneServiceClientModel.h>
namespace Aws
{
namespace IoTDataPlane
{
/**
* <fullname>IoT data</fullname> <p>IoT data enables secure, bi-directional
* communication between Internet-connected things (such as sensors, actuators,
* embedded devices, or smart appliances) and the Amazon Web Services cloud. It
* implements a broker for applications and things to publish messages over HTTP
* (Publish) and retrieve, update, and delete shadows. A shadow is a persistent
* representation of your things and their state in the Amazon Web Services
* cloud.</p> <p>Find the endpoint address for actions in IoT data by running this
* CLI command:</p> <p> <code>aws iot describe-endpoint --endpoint-type
* iot:Data-ATS</code> </p> <p>The service name used by <a
* href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Amazon
* Web ServicesSignature Version 4</a> to sign requests is:
* <i>iotdevicegateway</i>.</p>
*/
class AWS_IOTDATAPLANE_API IoTDataPlaneClient : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods<IoTDataPlaneClient>
{
public:
typedef Aws::Client::AWSJsonClient BASECLASS;
static const char* SERVICE_NAME;
static const char* ALLOCATION_TAG;
typedef IoTDataPlaneClientConfiguration ClientConfigurationType;
typedef IoTDataPlaneEndpointProvider EndpointProviderType;
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
IoTDataPlaneClient(const Aws::IoTDataPlane::IoTDataPlaneClientConfiguration& clientConfiguration = Aws::IoTDataPlane::IoTDataPlaneClientConfiguration(),
std::shared_ptr<IoTDataPlaneEndpointProviderBase> endpointProvider = Aws::MakeShared<IoTDataPlaneEndpointProvider>(ALLOCATION_TAG));
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
IoTDataPlaneClient(const Aws::Auth::AWSCredentials& credentials,
std::shared_ptr<IoTDataPlaneEndpointProviderBase> endpointProvider = Aws::MakeShared<IoTDataPlaneEndpointProvider>(ALLOCATION_TAG),
const Aws::IoTDataPlane::IoTDataPlaneClientConfiguration& clientConfiguration = Aws::IoTDataPlane::IoTDataPlaneClientConfiguration());
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
IoTDataPlaneClient(const std::shared_ptr<Aws::Auth::AWSCredentialsProvider>& credentialsProvider,
std::shared_ptr<IoTDataPlaneEndpointProviderBase> endpointProvider = Aws::MakeShared<IoTDataPlaneEndpointProvider>(ALLOCATION_TAG),
const Aws::IoTDataPlane::IoTDataPlaneClientConfiguration& clientConfiguration = Aws::IoTDataPlane::IoTDataPlaneClientConfiguration());
/* Legacy constructors due deprecation */
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
IoTDataPlaneClient(const Aws::Client::ClientConfiguration& clientConfiguration);
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
IoTDataPlaneClient(const Aws::Auth::AWSCredentials& credentials,
const Aws::Client::ClientConfiguration& clientConfiguration);
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
IoTDataPlaneClient(const std::shared_ptr<Aws::Auth::AWSCredentialsProvider>& credentialsProvider,
const Aws::Client::ClientConfiguration& clientConfiguration);
/* End of legacy constructors due deprecation */
virtual ~IoTDataPlaneClient();
/**
* <p>Deletes the shadow for the specified thing.</p> <p>Requires permission to
* access the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DeleteThingShadow</a>
* action.</p> <p>For more information, see <a
* href="http://docs.aws.amazon.com/iot/latest/developerguide/API_DeleteThingShadow.html">DeleteThingShadow</a>
* in the IoT Developer Guide.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/DeleteThingShadow">AWS
* API Reference</a></p>
*/
virtual Model::DeleteThingShadowOutcome DeleteThingShadow(const Model::DeleteThingShadowRequest& request) const;
/**
* A Callable wrapper for DeleteThingShadow that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename DeleteThingShadowRequestT = Model::DeleteThingShadowRequest>
Model::DeleteThingShadowOutcomeCallable DeleteThingShadowCallable(const DeleteThingShadowRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::DeleteThingShadow, request);
}
/**
* An Async wrapper for DeleteThingShadow that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename DeleteThingShadowRequestT = Model::DeleteThingShadowRequest>
void DeleteThingShadowAsync(const DeleteThingShadowRequestT& request, const DeleteThingShadowResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::DeleteThingShadow, request, handler, context);
}
/**
* <p>Gets the details of a single retained message for the specified topic.</p>
* <p>This action returns the message payload of the retained message, which can
* incur messaging costs. To list only the topic names of the retained messages,
* call <a
* href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_ListRetainedMessages.html">ListRetainedMessages</a>.</p>
* <p>Requires permission to access the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">GetRetainedMessage</a>
* action.</p> <p>For more information about messaging costs, see <a
* href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT
* Core pricing - Messaging</a>.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/GetRetainedMessage">AWS
* API Reference</a></p>
*/
virtual Model::GetRetainedMessageOutcome GetRetainedMessage(const Model::GetRetainedMessageRequest& request) const;
/**
* A Callable wrapper for GetRetainedMessage that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename GetRetainedMessageRequestT = Model::GetRetainedMessageRequest>
Model::GetRetainedMessageOutcomeCallable GetRetainedMessageCallable(const GetRetainedMessageRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::GetRetainedMessage, request);
}
/**
* An Async wrapper for GetRetainedMessage that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename GetRetainedMessageRequestT = Model::GetRetainedMessageRequest>
void GetRetainedMessageAsync(const GetRetainedMessageRequestT& request, const GetRetainedMessageResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::GetRetainedMessage, request, handler, context);
}
/**
* <p>Gets the shadow for the specified thing.</p> <p>Requires permission to access
* the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetThingShadow</a>
* action.</p> <p>For more information, see <a
* href="http://docs.aws.amazon.com/iot/latest/developerguide/API_GetThingShadow.html">GetThingShadow</a>
* in the IoT Developer Guide.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/GetThingShadow">AWS
* API Reference</a></p>
*/
virtual Model::GetThingShadowOutcome GetThingShadow(const Model::GetThingShadowRequest& request) const;
/**
* A Callable wrapper for GetThingShadow that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename GetThingShadowRequestT = Model::GetThingShadowRequest>
Model::GetThingShadowOutcomeCallable GetThingShadowCallable(const GetThingShadowRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::GetThingShadow, request);
}
/**
* An Async wrapper for GetThingShadow that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename GetThingShadowRequestT = Model::GetThingShadowRequest>
void GetThingShadowAsync(const GetThingShadowRequestT& request, const GetThingShadowResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::GetThingShadow, request, handler, context);
}
/**
* <p>Lists the shadows for the specified thing.</p> <p>Requires permission to
* access the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">ListNamedShadowsForThing</a>
* action.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/ListNamedShadowsForThing">AWS
* API Reference</a></p>
*/
virtual Model::ListNamedShadowsForThingOutcome ListNamedShadowsForThing(const Model::ListNamedShadowsForThingRequest& request) const;
/**
* A Callable wrapper for ListNamedShadowsForThing that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename ListNamedShadowsForThingRequestT = Model::ListNamedShadowsForThingRequest>
Model::ListNamedShadowsForThingOutcomeCallable ListNamedShadowsForThingCallable(const ListNamedShadowsForThingRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::ListNamedShadowsForThing, request);
}
/**
* An Async wrapper for ListNamedShadowsForThing that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename ListNamedShadowsForThingRequestT = Model::ListNamedShadowsForThingRequest>
void ListNamedShadowsForThingAsync(const ListNamedShadowsForThingRequestT& request, const ListNamedShadowsForThingResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::ListNamedShadowsForThing, request, handler, context);
}
/**
* <p>Lists summary information about the retained messages stored for the
* account.</p> <p>This action returns only the topic names of the retained
* messages. It doesn't return any message payloads. Although this action doesn't
* return a message payload, it can still incur messaging costs.</p> <p>To get the
* message payload of a retained message, call <a
* href="https://docs.aws.amazon.com/iot/latest/apireference/API_iotdata_GetRetainedMessage.html">GetRetainedMessage</a>
* with the topic name of the retained message.</p> <p>Requires permission to
* access the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotfleethubfordevicemanagement.html#awsiotfleethubfordevicemanagement-actions-as-permissions">ListRetainedMessages</a>
* action.</p> <p>For more information about messaging costs, see <a
* href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT
* Core pricing - Messaging</a>.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/ListRetainedMessages">AWS
* API Reference</a></p>
*/
virtual Model::ListRetainedMessagesOutcome ListRetainedMessages(const Model::ListRetainedMessagesRequest& request) const;
/**
* A Callable wrapper for ListRetainedMessages that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename ListRetainedMessagesRequestT = Model::ListRetainedMessagesRequest>
Model::ListRetainedMessagesOutcomeCallable ListRetainedMessagesCallable(const ListRetainedMessagesRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::ListRetainedMessages, request);
}
/**
* An Async wrapper for ListRetainedMessages that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename ListRetainedMessagesRequestT = Model::ListRetainedMessagesRequest>
void ListRetainedMessagesAsync(const ListRetainedMessagesRequestT& request, const ListRetainedMessagesResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::ListRetainedMessages, request, handler, context);
}
/**
* <p>Publishes an MQTT message.</p> <p>Requires permission to access the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">Publish</a>
* action.</p> <p>For more information about MQTT messages, see <a
* href="http://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html">MQTT
* Protocol</a> in the IoT Developer Guide.</p> <p>For more information about
* messaging costs, see <a
* href="http://aws.amazon.com/iot-core/pricing/#Messaging">Amazon Web Services IoT
* Core pricing - Messaging</a>.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/Publish">AWS
* API Reference</a></p>
*/
virtual Model::PublishOutcome Publish(const Model::PublishRequest& request) const;
/**
* A Callable wrapper for Publish that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename PublishRequestT = Model::PublishRequest>
Model::PublishOutcomeCallable PublishCallable(const PublishRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::Publish, request);
}
/**
* An Async wrapper for Publish that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename PublishRequestT = Model::PublishRequest>
void PublishAsync(const PublishRequestT& request, const PublishResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::Publish, request, handler, context);
}
/**
* <p>Updates the shadow for the specified thing.</p> <p>Requires permission to
* access the <a
* href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">UpdateThingShadow</a>
* action.</p> <p>For more information, see <a
* href="http://docs.aws.amazon.com/iot/latest/developerguide/API_UpdateThingShadow.html">UpdateThingShadow</a>
* in the IoT Developer Guide.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/iot-data-2015-05-28/UpdateThingShadow">AWS
* API Reference</a></p>
*/
virtual Model::UpdateThingShadowOutcome UpdateThingShadow(const Model::UpdateThingShadowRequest& request) const;
/**
* A Callable wrapper for UpdateThingShadow that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template<typename UpdateThingShadowRequestT = Model::UpdateThingShadowRequest>
Model::UpdateThingShadowOutcomeCallable UpdateThingShadowCallable(const UpdateThingShadowRequestT& request) const
{
return SubmitCallable(&IoTDataPlaneClient::UpdateThingShadow, request);
}
/**
* An Async wrapper for UpdateThingShadow that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template<typename UpdateThingShadowRequestT = Model::UpdateThingShadowRequest>
void UpdateThingShadowAsync(const UpdateThingShadowRequestT& request, const UpdateThingShadowResponseReceivedHandler& handler, const std::shared_ptr<const Aws::Client::AsyncCallerContext>& context = nullptr) const
{
return SubmitAsync(&IoTDataPlaneClient::UpdateThingShadow, request, handler, context);
}
void OverrideEndpoint(const Aws::String& endpoint);
std::shared_ptr<IoTDataPlaneEndpointProviderBase>& accessEndpointProvider();
private:
friend class Aws::Client::ClientWithAsyncTemplateMethods<IoTDataPlaneClient>;
void init(const IoTDataPlaneClientConfiguration& clientConfiguration);
IoTDataPlaneClientConfiguration m_clientConfiguration;
std::shared_ptr<Aws::Utils::Threading::Executor> m_executor;
std::shared_ptr<IoTDataPlaneEndpointProviderBase> m_endpointProvider;
};
} // namespace IoTDataPlane
} // namespace Aws