IoTSecureTunneling / Client / describe_tunnel

describe_tunnel#

IoTSecureTunneling.Client.describe_tunnel(**kwargs)#

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

Requires permission to access the DescribeTunnel action.

See also: AWS API Documentation

Request Syntax

response = client.describe_tunnel(
    tunnelId='string'
)
Parameters:

tunnelId (string) –

[REQUIRED]

The tunnel to describe.

Return type:

dict

Returns:

Response Syntax

{
    'tunnel': {
        'tunnelId': 'string',
        'tunnelArn': 'string',
        'status': 'OPEN'|'CLOSED',
        'sourceConnectionState': {
            'status': 'CONNECTED'|'DISCONNECTED',
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
        'destinationConnectionState': {
            'status': 'CONNECTED'|'DISCONNECTED',
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
        'description': 'string',
        'destinationConfig': {
            'thingName': 'string',
            'services': [
                'string',
            ]
        },
        'timeoutConfig': {
            'maxLifetimeTimeoutMinutes': 123
        },
        'tags': [
            {
                'key': 'string',
                'value': 'string'
            },
        ],
        'createdAt': datetime(2015, 1, 1),
        'lastUpdatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

  • (dict) –

    • tunnel (dict) –

      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.

      • sourceConnectionState (dict) –

        The connection state of the source application.

        • status (string) –

          The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.

        • lastUpdatedAt (datetime) –

          The last time the connection status was updated.

      • destinationConnectionState (dict) –

        The connection state of the destination application.

        • status (string) –

          The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED.

        • lastUpdatedAt (datetime) –

          The last time the connection status was updated.

      • description (string) –

        A description of the tunnel.

      • destinationConfig (dict) –

        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 (list) –

          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.

          • (string) –

      • timeoutConfig (dict) –

        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 (list) –

        A list of tag metadata associated with the secure tunnel.

        • (dict) –

          An arbitary key/value pair used to add searchable metadata to secure tunnel resources.

          • key (string) –

            The key of the tag.

          • value (string) –

            The value of the tag.

      • createdAt (datetime) –

        The time when the tunnel was created.

      • lastUpdatedAt (datetime) –

        The last time the tunnel was updated.

Exceptions