Table of Contents
IoTSecureTunneling.Client¶A low-level client representing AWS IoT Secure Tunneling
IoT Secure Tunneling creates remote connections to devices deployed in the field.
For more information about how IoT Secure Tunneling works, see IoT Secure Tunneling.
import boto3
client = boto3.client('iotsecuretunneling')
These are the available methods:
can_paginate()close()close_tunnel()describe_tunnel()get_paginator()get_waiter()list_tags_for_resource()list_tunnels()open_tunnel()rotate_tunnel_access_token()tag_resource()untag_resource()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.close()¶Closes underlying endpoint connections.
close_tunnel(**kwargs)¶Closes a tunnel identified by the unique tunnel id. When a CloseTunnel request is received, we close the WebSocket connections between the client and proxy server so no data can be transmitted.
Requires permission to access the CloseTunnel action.
See also: AWS API Documentation
Request Syntax
response = client.close_tunnel(
tunnelId='string',
delete=True|False
)
[REQUIRED]
The ID of the tunnel to close.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSecureTunneling.Client.exceptions.ResourceNotFoundExceptiondescribe_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'
)
[REQUIRED]
The tunnel to describe.
{
'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
The tunnel being described.
A unique alpha-numeric ID that identifies a tunnel.
The Amazon Resource Name (ARN) of a tunnel.
The status of a tunnel. Valid values are: Open and Closed.
The connection state of the source application.
The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED .
The last time the connection status was updated.
The connection state of the destination application.
The connection status of the tunnel. Valid values are CONNECTED and DISCONNECTED .
The last time the connection status was updated.
A description of the tunnel.
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.
The name of the IoT thing to which you want to connect.
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.
Timeout configuration for the tunnel.
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)
A list of tag metadata associated with the secure tunnel.
An arbitary key/value pair used to add searchable metadata to secure tunnel resources.
The key of the tag.
The value of the tag.
The time when the tunnel was created.
The last time the tunnel was updated.
Exceptions
IoTSecureTunneling.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_waiter(waiter_name)¶Returns an object that can wait for some condition.
Lists the tags for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The resource ARN.
{
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
Response Structure
The tags for the specified resource.
An arbitary key/value pair used to add searchable metadata to secure tunnel resources.
The key of the tag.
The value of the tag.
Exceptions
IoTSecureTunneling.Client.exceptions.ResourceNotFoundExceptionlist_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.
See also: AWS API Documentation
Request Syntax
response = client.list_tunnels(
thingName='string',
maxResults=123,
nextToken='string'
)
dict
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.
open_tunnel(**kwargs)¶Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.
Requires permission to access the OpenTunnel action.
See also: AWS API Documentation
Request Syntax
response = client.open_tunnel(
description='string',
tags=[
{
'key': 'string',
'value': 'string'
},
],
destinationConfig={
'thingName': 'string',
'services': [
'string',
]
},
timeoutConfig={
'maxLifetimeTimeoutMinutes': 123
}
)
A collection of tag metadata.
An arbitary key/value pair used to add searchable metadata to secure tunnel resources.
The key of the tag.
The value of the tag.
The destination configuration for the OpenTunnel request.
The name of the IoT thing to which you want to connect.
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.
Timeout configuration for a tunnel.
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)
dict
Response Syntax
{
'tunnelId': 'string',
'tunnelArn': 'string',
'sourceAccessToken': 'string',
'destinationAccessToken': 'string'
}
Response Structure
(dict) --
tunnelId (string) --
A unique alpha-numeric tunnel ID.
tunnelArn (string) --
The Amazon Resource Name for the tunnel.
sourceAccessToken (string) --
The access token the source local proxy uses to connect to IoT Secure Tunneling.
destinationAccessToken (string) --
The access token the destination local proxy uses to connect to IoT Secure Tunneling.
Exceptions
IoTSecureTunneling.Client.exceptions.LimitExceededExceptionrotate_tunnel_access_token(**kwargs)¶Revokes the current client access token (CAT) and returns new CAT for clients to use when reconnecting to secure tunneling to access the same tunnel.
Requires permission to access the RotateTunnelAccessToken action.
Note
Rotating the CAT doesn't extend the tunnel duration. For example, say the tunnel duration is 12 hours and the tunnel has already been open for 4 hours. When you rotate the access tokens, the new tokens that are generated can only be used for the remaining 8 hours.
See also: AWS API Documentation
Request Syntax
response = client.rotate_tunnel_access_token(
tunnelId='string',
clientMode='SOURCE'|'DESTINATION'|'ALL',
destinationConfig={
'thingName': 'string',
'services': [
'string',
]
}
)
[REQUIRED]
The tunnel for which you want to rotate the access tokens.
[REQUIRED]
The mode of the client that will use the client token, which can be either the source or destination, or both source and destination.
The destination configuration.
The name of the IoT thing to which you want to connect.
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.
dict
Response Syntax
{
'tunnelArn': 'string',
'sourceAccessToken': 'string',
'destinationAccessToken': 'string'
}
Response Structure
(dict) --
tunnelArn (string) --
The Amazon Resource Name for the tunnel.
sourceAccessToken (string) --
The client access token that the source local proxy uses to connect to IoT Secure Tunneling.
destinationAccessToken (string) --
The client access token that the destination local proxy uses to connect to IoT Secure Tunneling.
Exceptions
IoTSecureTunneling.Client.exceptions.ResourceNotFoundExceptiontag_resource(**kwargs)¶A resource tag.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags=[
{
'key': 'string',
'value': 'string'
},
]
)
[REQUIRED]
The ARN of the resource.
[REQUIRED]
The tags for the resource.
An arbitary key/value pair used to add searchable metadata to secure tunnel resources.
The key of the tag.
The value of the tag.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSecureTunneling.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Removes a tag from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The resource ARN.
[REQUIRED]
The keys of the tags to remove.
dict
Response Syntax
{}
Response Structure
Exceptions
IoTSecureTunneling.Client.exceptions.ResourceNotFoundExceptionThe available paginators are: