Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsecuretunneling ]

list-tunnels

Description

List all tunnels for an Amazon Web Services account. Tunnels are listed by creation time in descending order, newer tunnels will be listed before older tunnels.

Requires permission to access the ListTunnels action.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  list-tunnels
[--thing-name <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--thing-name (string)

The name of the IoT thing associated with the destination device.

--max-results (integer)

The maximum number of results to return at once.

--next-token (string)

To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

tunnelSummaries -> (list)

A short description of the tunnels in an Amazon Web Services account.

(structure)

Information about the tunnel.

tunnelId -> (string)

The unique alpha-numeric identifier for the tunnel.

tunnelArn -> (string)

The Amazon Resource Name of the tunnel.

status -> (string)

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

description -> (string)

A description of the tunnel.

createdAt -> (timestamp)

The time the tunnel was created.

lastUpdatedAt -> (timestamp)

The time the tunnel was last updated.

nextToken -> (string)

The token to use to get the next set of results, or null if there are no additional results.