Class: AWS.IoTSecureTunneling

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.

      • 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 identify the target application. The 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 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.

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.

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)

    To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first 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 Amazon Web Services account.

      • tunnelId — (String)

        The unique alpha-numeric identifier for the tunnel.

      • tunnelArn — (String)

        The Amazon Resource Name of the tunnel.

      • 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)

      The token to use to get 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.

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 identify the target application. The 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 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.

    • sourceAccessToken — (String)

      The access token the source local proxy uses to connect to IoT Secure Tunneling.

    • destinationAccessToken — (String)

      The access token the destination local proxy uses to connect to IoT Secure Tunneling.

Returns:

• (AWS.Request) —

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

var params = {
  clientMode: SOURCE | DESTINATION | ALL, /* required */
  tunnelId: 'STRING_VALUE', /* required */
  destinationConfig: {
    services: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    thingName: 'STRING_VALUE'
  }
};
iotsecuretunneling.rotateTunnelAccessToken(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 for which you want to rotate the access tokens.

  • clientMode — (String)

    The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.

    Possible values include:
    • "SOURCE"
    • "DESTINATION"
    • "ALL"
  • destinationConfig — (map)

    The destination configuration.

    • thingName — (String)

      The name of the IoT thing to which you want to connect.

    • services — required — (Array<String>)

      A list of service names that identify the target application. The 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 IoT client instantiates the local proxy, which uses this information to connect to the destination application.

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:

    • tunnelArn — (String)

      The Amazon Resource Name for the tunnel.

    • sourceAccessToken — (String)

      The client access token that the source local proxy uses to connect to IoT Secure Tunneling.

    • destinationAccessToken — (String)

      The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.

Returns:

• (AWS.Request) —

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

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.

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.