AWS SDK for C++  1.9.44
AWS SDK for C++
Public Types | Public Member Functions | List of all members
Aws::IoTDataPlane::IoTDataPlaneClient Class Reference

#include <IoTDataPlaneClient.h>

+ Inheritance diagram for Aws::IoTDataPlane::IoTDataPlaneClient:

Public Types

typedef Aws::Client::AWSJsonClient BASECLASS
 
- Public Types inherited from Aws::Client::AWSJsonClient
typedef AWSClient BASECLASS
 

Public Member Functions

 IoTDataPlaneClient (const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 IoTDataPlaneClient (const Aws::Auth::AWSCredentials &credentials, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
 IoTDataPlaneClient (const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &credentialsProvider, const Aws::Client::ClientConfiguration &clientConfiguration=Aws::Client::ClientConfiguration())
 
virtual ~IoTDataPlaneClient ()
 
virtual Model::DeleteThingShadowOutcome DeleteThingShadow (const Model::DeleteThingShadowRequest &request) const
 
virtual Model::DeleteThingShadowOutcomeCallable DeleteThingShadowCallable (const Model::DeleteThingShadowRequest &request) const
 
virtual void DeleteThingShadowAsync (const Model::DeleteThingShadowRequest &request, const DeleteThingShadowResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::GetThingShadowOutcome GetThingShadow (const Model::GetThingShadowRequest &request) const
 
virtual Model::GetThingShadowOutcomeCallable GetThingShadowCallable (const Model::GetThingShadowRequest &request) const
 
virtual void GetThingShadowAsync (const Model::GetThingShadowRequest &request, const GetThingShadowResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::ListNamedShadowsForThingOutcome ListNamedShadowsForThing (const Model::ListNamedShadowsForThingRequest &request) const
 
virtual Model::ListNamedShadowsForThingOutcomeCallable ListNamedShadowsForThingCallable (const Model::ListNamedShadowsForThingRequest &request) const
 
virtual void ListNamedShadowsForThingAsync (const Model::ListNamedShadowsForThingRequest &request, const ListNamedShadowsForThingResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::PublishOutcome Publish (const Model::PublishRequest &request) const
 
virtual Model::PublishOutcomeCallable PublishCallable (const Model::PublishRequest &request) const
 
virtual void PublishAsync (const Model::PublishRequest &request, const PublishResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
virtual Model::UpdateThingShadowOutcome UpdateThingShadow (const Model::UpdateThingShadowRequest &request) const
 
virtual Model::UpdateThingShadowOutcomeCallable UpdateThingShadowCallable (const Model::UpdateThingShadowRequest &request) const
 
virtual void UpdateThingShadowAsync (const Model::UpdateThingShadowRequest &request, const UpdateThingShadowResponseReceivedHandler &handler, const std::shared_ptr< const Aws::Client::AsyncCallerContext > &context=nullptr) const
 
void OverrideEndpoint (const Aws::String &endpoint)
 
- Public Member Functions inherited from Aws::Client::AWSJsonClient
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSJsonClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSJsonClient ()=default
 
- Public Member Functions inherited from Aws::Client::AWSClient
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Client::AWSAuthSigner > &signer, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
 AWSClient (const Aws::Client::ClientConfiguration &configuration, const std::shared_ptr< Aws::Auth::AWSAuthSignerProvider > &signerProvider, const std::shared_ptr< AWSErrorMarshaller > &errorMarshaller)
 
virtual ~AWSClient ()
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::HeaderValueCollection &customizedHeaders, long long expirationInSeconds=0)
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const char *serviceName, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
Aws::String GeneratePresignedUrl (const Aws::AmazonWebServiceRequest &request, Aws::Http::URI &uri, Aws::Http::HttpMethod method, const char *region, const Aws::Http::QueryStringParameterCollection &extraParams=Aws::Http::QueryStringParameterCollection(), long long expirationInSeconds=0) const
 
void DisableRequestProcessing ()
 
void EnableRequestProcessing ()
 
virtual const char * GetServiceClientName () const
 
virtual void SetServiceClientName (const Aws::String &name)
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Client::AWSJsonClient
virtual AWSError< CoreErrorsBuildAWSError (const std::shared_ptr< Aws::Http::HttpResponse > &response) const override
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeRequest (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
JsonOutcome MakeEventStreamRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Member Functions inherited from Aws::Client::AWSClient
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod httpMethod, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptExhaustively (const Aws::Http::URI &uri, Http::HttpMethod httpMethod, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const Aws::AmazonWebServiceRequest &request, const char *signerName, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
HttpResponseOutcome AttemptOneRequest (const std::shared_ptr< Http::HttpRequest > &httpRequest, const char *signerName, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
StreamOutcome MakeRequestWithUnparsedResponse (const Aws::Http::URI &uri, Http::HttpMethod method=Http::HttpMethod::HTTP_POST, const char *signerName=Aws::Auth::SIGV4_SIGNER, const char *requestName="", const char *signerRegionOverride=nullptr, const char *signerServiceNameOverride=nullptr) const
 
virtual void BuildHttpRequest (const Aws::AmazonWebServiceRequest &request, const std::shared_ptr< Aws::Http::HttpRequest > &httpRequest) const
 
const std::shared_ptr< AWSErrorMarshaller > & GetErrorMarshaller () const
 
Aws::Client::AWSAuthSignerGetSignerByName (const char *name) const
 
std::shared_ptr< Aws::Http::HttpRequestBuildAndSignHttpRequest (const Aws::Http::URI &uri, const Aws::AmazonWebServiceRequest &request, Http::HttpMethod method, const char *signerName) const
 
std::shared_ptr< Aws::Http::HttpResponseMakeHttpRequest (std::shared_ptr< Aws::Http::HttpRequest > &request) const
 
- Protected Attributes inherited from Aws::Client::AWSClient
Aws::String m_region
 

Detailed Description

<fullname>AWS IoT</fullname>

AWS IoT-Data enables secure, bi-directional communication between Internet-connected things (such as sensors, actuators, embedded devices, or smart appliances) and the AWS 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 AWS cloud.

Find the endpoint address for actions in the AWS IoT data plane by running this CLI command:

aws iot describe-endpoint –endpoint-type iot:Data-ATS

The service name used by AWS Signature Version 4 to sign requests is: iotdevicegateway.

Definition at line 98 of file IoTDataPlaneClient.h.

Member Typedef Documentation

◆ BASECLASS

Definition at line 101 of file IoTDataPlaneClient.h.

Constructor & Destructor Documentation

◆ IoTDataPlaneClient() [1/3]

Aws::IoTDataPlane::IoTDataPlaneClient::IoTDataPlaneClient ( const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::ClientConfiguration())

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() [2/3]

Aws::IoTDataPlane::IoTDataPlaneClient::IoTDataPlaneClient ( const Aws::Auth::AWSCredentials credentials,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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() [3/3]

Aws::IoTDataPlane::IoTDataPlaneClient::IoTDataPlaneClient ( const std::shared_ptr< Aws::Auth::AWSCredentialsProvider > &  credentialsProvider,
const Aws::Client::ClientConfiguration clientConfiguration = Aws::Client::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()

virtual Aws::IoTDataPlane::IoTDataPlaneClient::~IoTDataPlaneClient ( )
virtual

Member Function Documentation

◆ DeleteThingShadow()

virtual Model::DeleteThingShadowOutcome Aws::IoTDataPlane::IoTDataPlaneClient::DeleteThingShadow ( const Model::DeleteThingShadowRequest request) const
virtual

Deletes the shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

◆ DeleteThingShadowAsync()

virtual void Aws::IoTDataPlane::IoTDataPlaneClient::DeleteThingShadowAsync ( const Model::DeleteThingShadowRequest request,
const DeleteThingShadowResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Deletes the shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ DeleteThingShadowCallable()

virtual Model::DeleteThingShadowOutcomeCallable Aws::IoTDataPlane::IoTDataPlaneClient::DeleteThingShadowCallable ( const Model::DeleteThingShadowRequest request) const
virtual

Deletes the shadow for the specified thing.

For more information, see DeleteThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ GetThingShadow()

virtual Model::GetThingShadowOutcome Aws::IoTDataPlane::IoTDataPlaneClient::GetThingShadow ( const Model::GetThingShadowRequest request) const
virtual

Gets the shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

◆ GetThingShadowAsync()

virtual void Aws::IoTDataPlane::IoTDataPlaneClient::GetThingShadowAsync ( const Model::GetThingShadowRequest request,
const GetThingShadowResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Gets the shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ GetThingShadowCallable()

virtual Model::GetThingShadowOutcomeCallable Aws::IoTDataPlane::IoTDataPlaneClient::GetThingShadowCallable ( const Model::GetThingShadowRequest request) const
virtual

Gets the shadow for the specified thing.

For more information, see GetThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ ListNamedShadowsForThing()

virtual Model::ListNamedShadowsForThingOutcome Aws::IoTDataPlane::IoTDataPlaneClient::ListNamedShadowsForThing ( const Model::ListNamedShadowsForThingRequest request) const
virtual

Lists the shadows for the specified thing.

See Also:

AWS API Reference

◆ ListNamedShadowsForThingAsync()

virtual void Aws::IoTDataPlane::IoTDataPlaneClient::ListNamedShadowsForThingAsync ( const Model::ListNamedShadowsForThingRequest request,
const ListNamedShadowsForThingResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Lists the shadows for the specified thing.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ ListNamedShadowsForThingCallable()

virtual Model::ListNamedShadowsForThingOutcomeCallable Aws::IoTDataPlane::IoTDataPlaneClient::ListNamedShadowsForThingCallable ( const Model::ListNamedShadowsForThingRequest request) const
virtual

Lists the shadows for the specified thing.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ OverrideEndpoint()

void Aws::IoTDataPlane::IoTDataPlaneClient::OverrideEndpoint ( const Aws::String endpoint)

◆ Publish()

virtual Model::PublishOutcome Aws::IoTDataPlane::IoTDataPlaneClient::Publish ( const Model::PublishRequest request) const
virtual

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

See Also:

AWS API Reference

◆ PublishAsync()

virtual void Aws::IoTDataPlane::IoTDataPlaneClient::PublishAsync ( const Model::PublishRequest request,
const PublishResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ PublishCallable()

virtual Model::PublishOutcomeCallable Aws::IoTDataPlane::IoTDataPlaneClient::PublishCallable ( const Model::PublishRequest request) const
virtual

Publishes state information.

For more information, see HTTP Protocol in the AWS IoT Developer Guide.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.

◆ UpdateThingShadow()

virtual Model::UpdateThingShadowOutcome Aws::IoTDataPlane::IoTDataPlaneClient::UpdateThingShadow ( const Model::UpdateThingShadowRequest request) const
virtual

Updates the shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

◆ UpdateThingShadowAsync()

virtual void Aws::IoTDataPlane::IoTDataPlaneClient::UpdateThingShadowAsync ( const Model::UpdateThingShadowRequest request,
const UpdateThingShadowResponseReceivedHandler handler,
const std::shared_ptr< const Aws::Client::AsyncCallerContext > &  context = nullptr 
) const
virtual

Updates the shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

Queues the request into a thread executor and triggers associated callback when operation has finished.

◆ UpdateThingShadowCallable()

virtual Model::UpdateThingShadowOutcomeCallable Aws::IoTDataPlane::IoTDataPlaneClient::UpdateThingShadowCallable ( const Model::UpdateThingShadowRequest request) const
virtual

Updates the shadow for the specified thing.

For more information, see UpdateThingShadow in the AWS IoT Developer Guide.

See Also:

AWS API Reference

returns a future to the operation so that it can be executed in parallel to other requests.


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