The AWS SDK for JavaScript v2 has reached end-of-support.
We recommend that you migrate to AWS SDK for JavaScript v3. For additional details and information on how to migrate, please refer to the announcement.

Class: AWS.IoTThingsGraph

Inherits:
AWS.Service show all
Identifier:
iotthingsgraph
API Version:
2018-09-06
Defined in:
(unknown)

Overview

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

Service Description

AWS IoT Things Graph provides an integrated set of tools that enable developers to connect devices and services that use different standards, such as units of measure and communication protocols. AWS IoT Things Graph makes it possible to build IoT applications with little to no code by connecting devices and services and defining how they interact at an abstract level.

For more information about how AWS IoT Things Graph works, see the User Guide.

The AWS IoT Things Graph service is discontinued.

Sending a Request Using IoTThingsGraph

var iotthingsgraph = new AWS.IoTThingsGraph();
iotthingsgraph.associateEntityToThing(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 IoTThingsGraph object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotthingsgraph = new AWS.IoTThingsGraph({apiVersion: '2018-09-06'});

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

AWS.config.apiVersions = {
  iotthingsgraph: '2018-09-06',
  // other service API versions
};

var iotthingsgraph = new AWS.IoTThingsGraph();

Version:

  • 2018-09-06

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a IoTThingsGraph object

var iotthingsgraph = new AWS.IoTThingsGraph({apiVersion: '2018-09-06'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • 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.IoTThingsGraph.region for more information.