/

The AWS IoT Secure Tunneling multi-region endpoint

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

POST

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

Requires permission to access the DescribeTunnel 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 '{
    "tunnelId": "string"
}'

Response Example

200 - Example 1

{
    "tunnel": {
        "tunnelId": "string",
        "tunnelArn": "string",
        "status": "OPEN",
        "sourceConnectionState": {
            "status": "CONNECTED",
            "lastUpdatedAt": "string"
        },
        "destinationConnectionState": {},
        "description": "string",
        "destinationConfig": {
            "thingName": "string",
            "services": []
        },
        "timeoutConfig": {
            "maxLifetimeTimeoutMinutes": 0
        },
        "tags": [],
        "createdAt": "string",
        "lastUpdatedAt": "string"
    }
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

tunnelId

string

required

The tunnel to describe.

Match pattern:

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

Examples

Responses

🟢200Success

application/json

Body

tunnel

object

optional

The tunnel being described.

tunnelId

string

optional

A unique alpha-numeric ID that identifies a tunnel.

Match pattern:

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

tunnelArn

string

optional

The Amazon Resource Name (ARN) of a tunnel.

>= 1 characters<= 1600 characters

status

enum<string>

optional

The status of a tunnel. Valid values are: Open and Closed.

Allowed values:

OPENCLOSED

sourceConnectionState

object

optional

The connection state of the source application.

destinationConnectionState

object

optional

The connection state of the destination application.

description

string

optional

A description of the tunnel.

Match pattern:

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

destinationConfig

object

optional

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.

timeoutConfig

object

optional

Timeout configuration for the tunnel.