You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.IotData

Inherits:

AWS.Service

• Object
• AWS.Service
• AWS.IotData

Identifier:

iotdata

API Version:

2015-05-28

Defined in:

lib/services/iotdata.js

Overview

Note:

You must provide an endpoint configuration parameter when constructing this service. See constructor() for more information.

Constructs a service interface object. Each API operation is exposed as a function on service.

Sending a Request Using IotData

var iotdata = new AWS.IotData({endpoint: 'my.host.tld'});
iotdata.getThingShadow(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IotData object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotdata = new AWS.IotData({
  endpoint: 'my.host.tld',
  apiVersion: '2015-05-28'
});

You can also set the API version globally in AWS.config.apiVersions using the iotdata service identifier:

AWS.config.apiVersions = {
  iotdata: '2015-05-28',
  // other service API versions
};

var iotdata = new AWS.IotData({endpoint: 'my.host.tld'});

Version:

• 2015-05-28

Constructor Summary

• new AWS.IotData(options = {}) ⇒ Object constructor

  Constructs a service object.

Property Summary

• endpoint ⇒ AWS.Endpoint readwrite

  An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary

• deleteThingShadow(params = {}, callback) ⇒ AWS.Request

  Deletes the shadow for the specified thing.

  Requires permission to access the DeleteThingShadow action.

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

  .

• getRetainedMessage(params = {}, callback) ⇒ AWS.Request

  Gets the details of a single retained message for the specified topic.

  This action returns the message payload of the retained message, which can incur messaging costs.

• getThingShadow(params = {}, callback) ⇒ AWS.Request

  Gets the shadow for the specified thing.

  Requires permission to access the GetThingShadow action.

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

  .

• listNamedShadowsForThing(params = {}, callback) ⇒ AWS.Request

  Lists the shadows for the specified thing.

  Requires permission to access the ListNamedShadowsForThing action.

  .

• listRetainedMessages(params = {}, callback) ⇒ AWS.Request

  Lists summary information about the retained messages stored for the account.

  This action returns only the topic names of the retained messages.

• publish(params = {}, callback) ⇒ AWS.Request

  Publishes an MQTT message.

  Requires permission to access the Publish action.

  For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

  For more information about messaging costs, see IoT Core pricing - Messaging.

  .

• updateThingShadow(params = {}, callback) ⇒ AWS.Request

  Updates the shadow for the specified thing.

  Requires permission to access the UpdateThingShadow action.

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

  .

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, defineService

Constructor Details

new AWS.IotData(options = {}) ⇒ Object

Note:

You must provide an endpoint when constructing this service.

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a IotData object

var iotdata = new AWS.IotData({endpoint: 'my.host.tld'});

Options Hash (options):

• accessKeyId (String) —

  your AWS access key ID.

• secretAccessKey (String) —

  your AWS secret access key.

• sessionToken (AWS.Credentials) —

  the optional AWS session token to sign requests with.

• credentials (AWS.Credentials) —

  the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

• credentialProvider (AWS.CredentialProviderChain) —

  the provider chain used to resolve credentials if no static credentials property is set.

• region (String) —

  the region to send service requests to. See AWS.IotData.region for more information.

• maxRetries (Integer) —

  the maximum amount of retries to attempt with a request. See AWS.IotData.maxRetries for more information.

• maxRedirects (Integer) —

  the maximum amount of redirects to follow with a request. See AWS.IotData.maxRedirects for more information.

• sslEnabled (Boolean) —

  whether to enable SSL for requests.

• paramValidation (Boolean|map) —

  whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

  • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
  • max [Boolean] — Validates that a value meets the max constraint.
  • pattern [Boolean] — Validates that a string value matches a regular expression.
  • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
• computeChecksums (Boolean) —

  whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

• convertResponseTypes (Boolean) —

  whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

• correctClockSkew (Boolean) —

  whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

• s3ForcePathStyle (Boolean) —

  whether to force path style URLs for S3 objects.

• s3BucketEndpoint (Boolean) —

  whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

• s3DisableBodySigning (Boolean) —

  whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

• s3UsEast1RegionalEndpoint ('legacy'|'regional') —

  when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

• s3UseArnRegion (Boolean) —

  whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

• retryDelayOptions (map) —

  A set of options to configure the retry delay on retryable errors. Currently supported options are:

  • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
  • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
• httpOptions (map) —

  A set of options to pass to the low-level HTTP request. Currently supported options are:

  • proxy [String] — the URL to proxy requests through
  • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
  • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
  • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
  • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
  • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
• apiVersion (String, Date) —

  a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

• apiVersions (map<String, String|Date>) —

  a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

• logger (#write, #log) —

  an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

• systemClockOffset (Number) —

  an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

• signatureVersion (String) —

  the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

• signatureCache (Boolean) —

  whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

• dynamoDbCrc32 (Boolean) —

  whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

• useAccelerateEndpoint (Boolean) —

  Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

• clientSideMonitoring (Boolean) —

  whether to collect and publish this client's performance metrics of all its API requests.

• endpointDiscoveryEnabled (Boolean|undefined) —

  whether to call operations with endpoints given by service dynamically. Setting this

• endpointCacheSize (Number) —

  the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

• hostPrefixEnabled (Boolean) —

  whether to marshal request parameters to the prefix of hostname. Defaults to true.

• stsRegionalEndpoints ('legacy'|'regional') —

  whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

• (AWS.Endpoint) —

  an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteThingShadow(params = {}, callback) ⇒ AWS.Request

Deletes the shadow for the specified thing.

Requires permission to access the DeleteThingShadow action.

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

Service Reference:

• DeleteThingShadow

Examples:

Calling the deleteThingShadow operation

var params = {
  thingName: 'STRING_VALUE', /* required */
  shadowName: 'STRING_VALUE'
};
iotdata.deleteThingShadow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • thingName — (String)

    The name of the thing.

  • shadowName — (String)

    The name of the shadow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • payload — (Buffer(Node.js), Typed Array(Browser))

      The state information, in JSON format.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

getRetainedMessage(params = {}, callback) ⇒ AWS.Request

Gets the details of a single retained message for the specified topic.

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 ListRetainedMessages.

Requires permission to access the GetRetainedMessage action.

For more information about messaging costs, see IoT Core pricing - Messaging.

Service Reference:

• GetRetainedMessage

Examples:

Calling the getRetainedMessage operation

var params = {
  topic: 'STRING_VALUE' /* required */
};
iotdata.getRetainedMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • topic — (String)

    The topic name of the retained message to retrieve.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • topic — (String)

      The topic name to which the retained message was published.

    • payload — (Buffer(Node.js), Typed Array(Browser))

      The Base64-encoded message payload of the retained message body.

    • qos — (Integer)

      The quality of service (QoS) level used to publish the retained message.

    • lastModifiedTime — (Integer)

      The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

getThingShadow(params = {}, callback) ⇒ AWS.Request

Gets the shadow for the specified thing.

Requires permission to access the GetThingShadow action.

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

Service Reference:

• GetThingShadow

Examples:

Calling the getThingShadow operation

var params = {
  thingName: 'STRING_VALUE', /* required */
  shadowName: 'STRING_VALUE'
};
iotdata.getThingShadow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • thingName — (String)

    The name of the thing.

  • shadowName — (String)

    The name of the shadow.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • payload — (Buffer(Node.js), Typed Array(Browser))

      The state information, in JSON format.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

listNamedShadowsForThing(params = {}, callback) ⇒ AWS.Request

Lists the shadows for the specified thing.

Requires permission to access the ListNamedShadowsForThing action.

Service Reference:

• ListNamedShadowsForThing

Examples:

Calling the listNamedShadowsForThing operation

var params = {
  thingName: 'STRING_VALUE', /* required */
  nextToken: 'STRING_VALUE',
  pageSize: 'NUMBER_VALUE'
};
iotdata.listNamedShadowsForThing(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • thingName — (String)

    The name of the thing.

  • nextToken — (String)

    The token to retrieve the next set of results.

  • pageSize — (Integer)

    The result page size.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • results — (Array<String>)

      The list of shadows for the specified thing.

    • nextToken — (String)

      The token to use to get the next set of results, or null if there are no additional results.

    • timestamp — (Integer)

      The Epoch date and time the response was generated by IoT.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

listRetainedMessages(params = {}, callback) ⇒ AWS.Request

Lists summary information about the retained messages stored for the account.

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.

To get the message payload of a retained message, call GetRetainedMessage with the topic name of the retained message.

Requires permission to access the ListRetainedMessages action.

For more information about messaging costs, see IoT Core pricing - Messaging.

Service Reference:

• ListRetainedMessages

Examples:

Calling the listRetainedMessages operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
iotdata.listRetainedMessages(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • nextToken — (String)

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

  • maxResults — (Integer)

    The maximum number of results to return at one time.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • retainedTopics — (Array<map>)

      A summary list the account's retained messages. The information returned doesn't include the message payloads of the retained messages.

      • topic — (String)

        The topic name to which the retained message was published.

      • payloadSize — (Integer)

        The size of the retained message's payload in bytes.

      • qos — (Integer)

        The quality of service (QoS) level used to publish the retained message.

      • lastModifiedTime — (Integer)

        The Epoch date and time, in milliseconds, when the retained message was stored by IoT.

    • nextToken — (String)

      The token for the next set of results, or null if there are no additional results.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

publish(params = {}, callback) ⇒ AWS.Request

Publishes an MQTT message.

Requires permission to access the Publish action.

For more information about MQTT messages, see MQTT Protocol in the IoT Developer Guide.

For more information about messaging costs, see IoT Core pricing - Messaging.

Service Reference:

• Publish

Examples:

Calling the publish operation

var params = {
  topic: 'STRING_VALUE', /* required */
  payload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */,
  qos: 'NUMBER_VALUE',
  retain: true || false
};
iotdata.publish(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • topic — (String)

    The name of the MQTT topic.

  • qos — (Integer)

    The Quality of Service (QoS) level.

  • retain — (Boolean)

    A Boolean value that determines whether to set the RETAIN flag when the message is published.

    Setting the RETAIN flag causes the message to be retained and sent to new subscribers to the topic.

    Valid values: true | false

    Default value: false

  • payload — (Buffer, Typed Array, Blob, String)

    The message body. MQTT accepts text, binary, and empty (null) message payloads.

    Publishing an empty (null) payload with retain = true deletes the retained message identified by topic from IoT Core.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

updateThingShadow(params = {}, callback) ⇒ AWS.Request

Updates the shadow for the specified thing.

Requires permission to access the UpdateThingShadow action.

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

Service Reference:

• UpdateThingShadow

Examples:

Calling the updateThingShadow operation

var params = {
  payload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
  thingName: 'STRING_VALUE', /* required */
  shadowName: 'STRING_VALUE'
};
iotdata.updateThingShadow(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • thingName — (String)

    The name of the thing.

  • shadowName — (String)

    The name of the shadow.

  • payload — (Buffer, Typed Array, Blob, String)

    The state information, in JSON format.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • payload — (Buffer(Node.js), Typed Array(Browser))

      The state information, in JSON format.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.