AWS IoT Secure Tunneling

/

The AWS IoT Secure Tunneling multi-region endpoint

http://api.tunneling.iot.{region}.amazonaws.com

POST

/

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'http://api.tunneling.iot.{region}.amazonaws.com/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string",
    "tags": [],
    "destinationConfig": {
        "thingName": "string",
        "services": []
    },
    "timeoutConfig": {
        "maxLifetimeTimeoutMinutes": 0
    }
}'

Response Example

200 - Example 1

{
    "tunnelId": "string",
    "tunnelArn": "string",
    "sourceAccessToken": "string",
    "destinationAccessToken": "string"
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

description

string

optional

A short text description of the tunnel.

Match pattern:

[^\p{C}]{1,2048}

tags

array[object (Tag) {2}]

optional

A collection of tag metadata.

>= 1 items<= 200 items

key

string

required

The key of the tag.

>= 1 characters<= 128 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

value

string

required

The value of the tag.

>= 0 characters<= 256 characters

Match pattern:

^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

destinationConfig

object

optional

The destination configuration for the OpenTunnel request.

thingName

string

optional

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

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9:_-]+

services

array[string]

required

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.

>= 1 items

timeoutConfig

object

optional

Timeout configuration for a tunnel.

maxLifetimeTimeoutMinutes

integer

optional

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)

>= 1<= 720

Examples

Responses

🟢200Success

application/json

Body

tunnelId

string

optional

A unique alpha-numeric tunnel ID.

Match pattern:

[a-zA-Z0-9_\-+=:]{1,128}

tunnelArn

string

optional

The Amazon Resource Name for the tunnel.

>= 1 characters<= 1600 characters

sourceAccessToken

string <password>

optional

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

destinationAccessToken

string <password>

optional

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

🟠480LimitExceededException

Modified at 2023-08-16 07:32:16