Skip to content
AWS for Query.Farm

aws.iotsecuretunneling.describe_tunnel

Example SQL Queries

SELECT * FROM
aws.iotsecuretunneling.describe_tunnel
WHERE
"tunnel_id" = 'VALUE';

Description

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

Requires permission to access the DescribeTunnel action.

Table Definition

Column NameColumn Data Type
tunnel_id Required Input Column

The tunnel to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

tunnel

The tunnel being described.

STRUCT(
    "tunnel_id" VARCHAR,
    "tunnel_arn" VARCHAR,
    "status" VARCHAR,
    "source_connection_state" STRUCT(
        "status" VARCHAR,
        "last_updated_at" TIMESTAMP_S
    ),
    "destination_connection_state" STRUCT(
        "status" VARCHAR,
        "last_updated_at" TIMESTAMP_S
    ),
    "description" VARCHAR,
    "destination_config" STRUCT(
        "thing_name" VARCHAR,
        "services" VARCHAR[]
    ),
    "timeout_config" STRUCT(
        "max_lifetime_timeout_minutes" BIGINT
    ),
    "tags" STRUCT(
        "key" VARCHAR,
        "value" VARCHAR
    )[],
    "created_at" TIMESTAMP_S,
    "last_updated_at" TIMESTAMP_S
)
Show child fields
tunnel.created_at

The time when the tunnel was created.

tunnel.description

A description of the tunnel.

tunnel.destination_config

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.

Show child fields
tunnel.destination_config.services[]
tunnel.destination_config.thing_name

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

tunnel.destination_connection_state

The connection state of the destination application.

Show child fields
tunnel.destination_connection_state.last_updated_at

The last time the connection status was updated.

tunnel.destination_connection_state.status

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

tunnel.last_updated_at

The last time the tunnel was updated.

tunnel.source_connection_state

The connection state of the source application.

Show child fields
tunnel.source_connection_state.last_updated_at

The last time the connection status was updated.

tunnel.source_connection_state.status

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

tunnel.status

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

tunnel.tags[]
Show child fields
tunnel.tags[].key

The key of the tag.

tunnel.tags[].value

The value of the tag.

tunnel.timeout_config

Timeout configuration for the tunnel.

Show child fields
tunnel.timeout_config.max_lifetime_timeout_minutes

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)

tunnel.tunnel_arn

The Amazon Resource Name (ARN) of a tunnel.

tunnel.tunnel_id

A unique alpha-numeric ID that identifies a tunnel.