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

Inherits:

AWS.Service

Object
AWS.Service
AWS.IoTSecureTunneling

show all

Identifier:: iotsecuretunneling

API Version:: 2018-10-05

Defined in:: (unknown)

Overview

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

Service Description

AWS IoT Secure Tunnling enables you to create remote connections to devices deployed in the field.

For more information about how AWS IoT Secure Tunneling works, see AWS 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();

Version:

2018-10-05

Constructor Summary collapse

new AWS.IoTSecureTunneling(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

closeTunnel(params = {}, callback) ⇒ AWS.Request
Closes a tunnel identified by the unique tunnel id.
describeTunnel(params = {}, callback) ⇒ AWS.Request
Gets information about a tunnel identified by the unique tunnel id.

.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Lists the tags for the specified resource.

.
listTunnels(params = {}, callback) ⇒ AWS.Request
List all tunnels for an AWS account.
openTunnel(params = {}, callback) ⇒ AWS.Request
Creates a new tunnel, and returns two client access tokens for clients to use to connect to the AWS IoT Secure Tunneling proxy server.

.
tagResource(params = {}, callback) ⇒ AWS.Request
A resource tag.

.
untagResource(params = {}, callback) ⇒ AWS.Request
Removes a tag from a resource.

.

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.

Examples:

Constructing a IoTSecureTunneling object

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

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.IoTSecureTunneling.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.IoTSecureTunneling.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.IoTSecureTunneling.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

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.

Service Reference:

CloseTunnel

Examples:

Calling the closeTunnel operation

var params = {
  tunnelId: 'STRING_VALUE', /* required */
  delete: true || false
};
iotsecuretunneling.closeTunnel(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: {}) —
- tunnelId — (String)
  The ID of the tunnel to close.
- delete — (Boolean)
  When set to true, AWS IoT Secure Tunneling deletes the tunnel data immediately.

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.

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

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

Service Reference:

DescribeTunnel

Examples:

Calling the describeTunnel operation

var params = {
  tunnelId: 'STRING_VALUE' /* required */
};
iotsecuretunneling.describeTunnel(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: {}) —
- tunnelId — (String)
  The tunnel to describe.

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:
  - tunnel — (map)
    The tunnel being described.
    
    tunnelId — (String)
    A unique alpha-numeric ID that identifies a tunnel.
    
    tunnelArn — (String)
    The Amazon Resource Name (ARN) of a tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
    
    status — (String)
    The status of a tunnel. Valid values are: Open and Closed.
    Possible values include:
    
    "OPEN"
    
    "CLOSED"
    
    sourceConnectionState — (map)
    The connection state of the source application.
    
    status — (String)
    The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.
    Possible values include:
    
    "CONNECTED"
    
    "DISCONNECTED"
    
    lastUpdatedAt — (Date)
    The last time the connection status was updated.
    
    destinationConnectionState — (map)
    The connection state of the destination application.
    
    status — (String)
    The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.
    Possible values include:
    
    "CONNECTED"
    
    "DISCONNECTED"
    
    lastUpdatedAt — (Date)
    The last time the connection status was updated.
    
    description — (String)
    A description of the tunnel.
    
    destinationConfig — (map)
    The destination configuration that specifies the thing name of the destination device and a service name that the local proxy uses to connect to the destination application.
    
    thingName — (String)
    The name of the IoT thing to which you want to connect.
    
    services — required — (Array<String>)
    A list of service names that identity the target application. The AWS IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.
    
    timeoutConfig — (map)
    Timeout configuration for the tunnel.
    
    maxLifetimeTimeoutMinutes — (Integer)
    The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes)
    
    tags — (Array<map>)
    A list of tag metadata associated with the secure tunnel.
    
    key — required — (String)
    The key of the tag.
    
    value — required — (String)
    The value of the tag.
    
    createdAt — (Date)
    The time when the tunnel was created.
    
    lastUpdatedAt — (Date)
    The last time the tunnel was updated.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

Lists the tags for the specified resource.

Service Reference:

ListTagsForResource

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
iotsecuretunneling.listTagsForResource(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: {}) —
- resourceArn — (String)
  The resource ARN.

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:
  - tags — (Array<map>)
    The tags for the specified resource.
    
    key — required — (String)
    The key of the tag.
    
    value — required — (String)
    The value of the tag.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

ListTunnels

Examples:

Calling the listTunnels operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  thingName: 'STRING_VALUE'
};
iotsecuretunneling.listTunnels(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 IoT thing associated with the destination device.
- maxResults — (Integer)
  The maximum number of results to return at once.
- nextToken — (String)
  A token to retrieve the next set of results.

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:
  - tunnelSummaries — (Array<map>)
    A short description of the tunnels in an AWS account.
    
    tunnelId — (String)
    The unique alpha-numeric identifier for the tunnel.
    
    tunnelArn — (String)
    The Amazon Resource Name of the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
    
    status — (String)
    The status of a tunnel. Valid values are: Open and Closed.
    Possible values include:
    
    "OPEN"
    
    "CLOSED"
    
    description — (String)
    A description of the tunnel.
    
    createdAt — (Date)
    The time the tunnel was created.
    
    lastUpdatedAt — (Date)
    The time the tunnel was last updated.
  - nextToken — (String)
    A token to used to retrieve the next set of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

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

Service Reference:

OpenTunnel

Examples:

Calling the openTunnel operation

var params = {
  description: 'STRING_VALUE',
  destinationConfig: {
    services: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    thingName: 'STRING_VALUE'
  },
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  timeoutConfig: {
    maxLifetimeTimeoutMinutes: 'NUMBER_VALUE'
  }
};
iotsecuretunneling.openTunnel(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: {}) —
- description — (String)
  A short text description of the tunnel.
- tags — (Array<map>)
  A collection of tag metadata.
  - key — required — (String)
    The key of the tag.
  - value — required — (String)
    The value of the tag.
- destinationConfig — (map)
  The destination configuration for the OpenTunnel request.
  - thingName — (String)
    The name of the IoT thing to which you want to connect.
  - services — required — (Array<String>)
    A list of service names that identity the target application. The AWS IoT client running on the destination device reads this value and uses it to look up a port or an IP address and a port. The AWS IoT client instantiates the local proxy which uses this information to connect to the destination application.
- timeoutConfig — (map)
  Timeout configuration for a tunnel.
  - maxLifetimeTimeoutMinutes — (Integer)
    The maximum amount of time (in minutes) a tunnel can remain open. If not specified, maxLifetimeTimeoutMinutes defaults to 720 minutes. Valid values are from 1 minute to 12 hours (720 minutes)

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:
  - tunnelId — (String)
    A unique alpha-numeric tunnel ID.
  - tunnelArn — (String)
    The Amazon Resource Name for the tunnel. The tunnel ARN format is arn:aws:tunnel:<region>:<account-id>:tunnel/<tunnel-id>
  - sourceAccessToken — (String)
    The access token the source local proxy uses to connect to AWS IoT Secure Tunneling.
  - destinationAccessToken — (String)
    The access token the destination local proxy uses to connect to AWS IoT Secure Tunneling.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

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

A resource tag.

Service Reference:

TagResource

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotsecuretunneling.tagResource(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: {}) —
- resourceArn — (String)
  The ARN of the resource.
- tags — (Array<map>)
  The tags for the resource.
  - key — required — (String)
    The key of the tag.
  - value — required — (String)
    The value of the tag.

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.

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

Removes a tag from a resource.

Service Reference:

UntagResource

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iotsecuretunneling.untagResource(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: {}) —
- resourceArn — (String)
  The resource ARN.
- tagKeys — (Array<String>)
  The keys of the tags to remove.

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.

Class: AWS.IoTSecureTunneling

Overview

Service Description

Sending a Request Using IoTSecureTunneling

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

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

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

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

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

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

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

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

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

endpoint ⇒ `AWS.Endpoint` (readwrite)

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

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

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

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

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

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

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