IoTSecureTunnelingClient
Index > IoTSecureTunneling > IoTSecureTunnelingClient
Auto-generated documentation for IoTSecureTunneling type annotations stubs module mypy-boto3-iotsecuretunneling.
IoTSecureTunnelingClient
Type annotations and code completion for boto3.client("iotsecuretunneling")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_iotsecuretunneling.client import IoTSecureTunnelingClient
def get_iotsecuretunneling_client() -> IoTSecureTunnelingClient:
return Session().client("iotsecuretunneling")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("iotsecuretunneling").exceptions
structure.
client = boto3.client("iotsecuretunneling")
try:
do_something(client)
except (
client.ClientError,
client.LimitExceededException,
client.ResourceNotFoundException,
) as e:
print(e)
from mypy_boto3_iotsecuretunneling.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("iotsecuretunneling").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("iotsecuretunneling").close
method.
boto3 documentation
close_tunnel
Closes a tunnel identified by the unique tunnel id.
Type annotations and code completion for boto3.client("iotsecuretunneling").close_tunnel
method.
boto3 documentation
def close_tunnel(
self,
*,
tunnelId: str,
delete: bool = ...,
) -> Dict[str, Any]:
...
kwargs: CloseTunnelRequestRequestTypeDef = { # (1)
"tunnelId": ...,
}
parent.close_tunnel(**kwargs)
describe_tunnel
Gets information about a tunnel identified by the unique tunnel id.
Type annotations and code completion for boto3.client("iotsecuretunneling").describe_tunnel
method.
boto3 documentation
def describe_tunnel(
self,
*,
tunnelId: str,
) -> DescribeTunnelResponseTypeDef: # (1)
...
kwargs: DescribeTunnelRequestRequestTypeDef = { # (1)
"tunnelId": ...,
}
parent.describe_tunnel(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("iotsecuretunneling").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_tags_for_resource
Lists the tags for the specified resource.
Type annotations and code completion for boto3.client("iotsecuretunneling").list_tags_for_resource
method.
boto3 documentation
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_tunnels
List all tunnels for an Amazon Web Services account.
Type annotations and code completion for boto3.client("iotsecuretunneling").list_tunnels
method.
boto3 documentation
def list_tunnels(
self,
*,
thingName: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTunnelsResponseTypeDef: # (1)
...
kwargs: ListTunnelsRequestRequestTypeDef = { # (1)
"thingName": ...,
}
parent.list_tunnels(**kwargs)
open_tunnel
Creates a new tunnel, and returns two client access tokens for clients to use to connect to the IoT Secure Tunneling proxy server.
Type annotations and code completion for boto3.client("iotsecuretunneling").open_tunnel
method.
boto3 documentation
def open_tunnel(
self,
*,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
destinationConfig: DestinationConfigTypeDef = ..., # (2)
timeoutConfig: TimeoutConfigTypeDef = ..., # (3)
) -> OpenTunnelResponseTypeDef: # (4)
...
kwargs: OpenTunnelRequestRequestTypeDef = { # (1)
"description": ...,
}
parent.open_tunnel(**kwargs)
rotate_tunnel_access_token
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.
Type annotations and code completion for boto3.client("iotsecuretunneling").rotate_tunnel_access_token
method.
boto3 documentation
def rotate_tunnel_access_token(
self,
*,
tunnelId: str,
clientMode: ClientModeType, # (1)
destinationConfig: DestinationConfigTypeDef = ..., # (2)
) -> RotateTunnelAccessTokenResponseTypeDef: # (3)
...
kwargs: RotateTunnelAccessTokenRequestRequestTypeDef = { # (1)
"tunnelId": ...,
"clientMode": ...,
}
parent.rotate_tunnel_access_token(**kwargs)
tag_resource
A resource tag.
Type annotations and code completion for boto3.client("iotsecuretunneling").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...
- See TagTypeDef
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Removes a tag from a resource.
Type annotations and code completion for boto3.client("iotsecuretunneling").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...