AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing IotData AWS IoT

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 thing shadows. A thing shadow is a persistent representation of your things and their state in the AWS cloud.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.IotData.AmazonIotDataClient

Namespace: Amazon.IotData
Assembly: AWSSDK.IotData.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonIotDataClient : AmazonServiceClient
         IAmazonIotData, IAmazonService, IDisposable

The AmazonIotDataClient type exposes the following members

Constructors

NameDescription
Public Method AmazonIotDataClient(string)

Constructs AmazonIotDataClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIotDataClient(AmazonIotDataConfig)

Constructs AmazonIotDataClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonIotDataClient(string, AWSCredentials)

Constructs AmazonIotDataClient with AWS Credentials

Public Method AmazonIotDataClient(AWSCredentials, AmazonIotDataConfig)

Constructs AmazonIotDataClient with AWS Credentials and an AmazonIotDataClient Configuration object.

Public Method AmazonIotDataClient(string, string, string)

Constructs AmazonIotDataClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIotDataClient(string, string, AmazonIotDataConfig)

Constructs AmazonIotDataClient with AWS Access Key ID, AWS Secret Key and an AmazonIotDataClient Configuration object.

Public Method AmazonIotDataClient(string, string, string, string)

Constructs AmazonIotDataClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonIotDataClient(string, string, string, AmazonIotDataConfig)

Constructs AmazonIotDataClient with AWS Access Key ID, AWS Secret Key and an AmazonIotDataClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method DeleteThingShadow(DeleteThingShadowRequest)

Deletes the thing shadow for the specified thing.

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

Public Method DeleteThingShadowAsync(DeleteThingShadowRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteThingShadow operation.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetThingShadow(GetThingShadowRequest)

Gets the thing shadow for the specified thing.

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

Public Method GetThingShadowAsync(GetThingShadowRequest, CancellationToken)

Initiates the asynchronous execution of the GetThingShadow operation.

Public Method Publish(PublishRequest)

Publishes state information.

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

Public Method PublishAsync(PublishRequest, CancellationToken)

Initiates the asynchronous execution of the Publish operation.

Public Method UpdateThingShadow(UpdateThingShadowRequest)

Updates the thing shadow for the specified thing.

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

Public Method UpdateThingShadowAsync(UpdateThingShadowRequest, CancellationToken)

Initiates the asynchronous execution of the UpdateThingShadow operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms