IoTSecureTunneling / Client / list_tunnels

list_tunnels#

IoTSecureTunneling.Client.list_tunnels(**kwargs)#

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.

Request Syntax

response = client.list_tunnels(
    thingName='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

thingName (string) – The name of the IoT thing associated with the destination device.
maxResults (integer) – The maximum number of results to return at once.
nextToken (string) – To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Return type:

dict

Returns:

Response Syntax

{
    'tunnelSummaries': [
        {
            'tunnelId': 'string',
            'tunnelArn': 'string',
            'status': 'OPEN'|'CLOSED',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- tunnelSummaries (list) –
  
  A short description of the tunnels in an Amazon Web Services account.
  - (dict) –
    
    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 (datetime) –
      
      The time the tunnel was created.
    - lastUpdatedAt (datetime) –
      
      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.