AWS.IoTSecureTunneling — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Overview

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

Service Description

IoT Secure Tunneling creates remote connections to devices deployed in the field.

For more information about how IoT Secure Tunneling works, see IoT Secure Tunneling.

Sending a Request Using IoTSecureTunneling

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

var iotsecuretunneling = new AWS.IoTSecureTunneling({apiVersion: '2018-10-05'});

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

AWS.config.apiVersions = {
  iotsecuretunneling: '2018-10-05',
  // other service API versions
};

var iotsecuretunneling = new AWS.IoTSecureTunneling();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Property Details

endpoint ⇒ AWS.Endpoint

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

Method Details

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

Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.

Requires permission to access the CloseTunnel action.

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

Gets information about a tunnel identified by the unique tunnel id.

Requires permission to access the DescribeTunnel action.

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

Lists the tags for the specified resource.

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

List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Requires permission to access the ListTunnels action.

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

Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.

Requires permission to access the OpenTunnel action.

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

Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel.

Requires permission to access the RotateTunnelAccessToken action.

Note: Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours.

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

Removes a tag from a resource.