/

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

Body Params application/json

Examples

Responses

🟢200Success

application/json

Body

🟠480ResourceNotFoundException

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