IoTSecureTunnelingClient#
Index > IoTSecureTunneling > IoTSecureTunnelingClient
Auto-generated documentation for IoTSecureTunneling type annotations stubs module types-aiobotocore-iotsecuretunneling.
IoTSecureTunnelingClient#
Type annotations and code completion for session.create_client("iotsecuretunneling")
boto3 documentation
IoTSecureTunnelingClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_iotsecuretunneling.client import IoTSecureTunnelingClient
session = get_session()
async with session.create_client("iotsecuretunneling") as client:
client: IoTSecureTunnelingClientExceptions#
aiobotocore client exceptions are generated in runtime.
This class provides code completion for session.create_client("iotsecuretunneling").exceptions structure.
IoTSecureTunnelingClient.exceptions usage example
async with session.create_client("iotsecuretunneling") as client:
try:
do_something(client)
except (
client.ClientError,
client.LimitExceededException,
client.ResourceNotFoundException,
) as e:
print(e)IoTSecureTunnelingClient usage type checking example
from types_aiobotocore_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 session.create_client("iotsecuretunneling").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("iotsecuretunneling").close method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...close_tunnel#
Closes a tunnel identified by the unique tunnel id.
Type annotations and code completion for session.create_client("iotsecuretunneling").close_tunnel method.
boto3 documentation
# close_tunnel method definition
await def close_tunnel(
self,
*,
tunnelId: str,
delete: bool = ...,
) -> Dict[str, Any]:
...# close_tunnel method usage example with argument unpacking
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 session.create_client("iotsecuretunneling").describe_tunnel method.
boto3 documentation
# describe_tunnel method definition
await def describe_tunnel(
self,
*,
tunnelId: str,
) -> DescribeTunnelResponseTypeDef: # (1)
...# describe_tunnel method usage example with argument unpacking
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 session.create_client("iotsecuretunneling").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("iotsecuretunneling").list_tags_for_resource method.
boto3 documentation
# list_tags_for_resource method definition
await def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...# list_tags_for_resource method usage example with argument unpacking
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 session.create_client("iotsecuretunneling").list_tunnels method.
boto3 documentation
# list_tunnels method definition
await def list_tunnels(
self,
*,
thingName: str = ...,
maxResults: int = ...,
nextToken: str = ...,
) -> ListTunnelsResponseTypeDef: # (1)
...# list_tunnels method usage example with argument unpacking
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 session.create_client("iotsecuretunneling").open_tunnel method.
boto3 documentation
# open_tunnel method definition
await def open_tunnel(
self,
*,
description: str = ...,
tags: Sequence[TagTypeDef] = ..., # (1)
destinationConfig: DestinationConfigTypeDef = ..., # (2)
timeoutConfig: TimeoutConfigTypeDef = ..., # (3)
) -> OpenTunnelResponseTypeDef: # (4)
...# open_tunnel method usage example with argument unpacking
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 session.create_client("iotsecuretunneling").rotate_tunnel_access_token method.
boto3 documentation
# rotate_tunnel_access_token method definition
await def rotate_tunnel_access_token(
self,
*,
tunnelId: str,
clientMode: ClientModeType, # (1)
destinationConfig: DestinationConfigTypeDef = ..., # (2)
) -> RotateTunnelAccessTokenResponseTypeDef: # (3)
...# rotate_tunnel_access_token method usage example with argument unpacking
kwargs: RotateTunnelAccessTokenRequestRequestTypeDef = { # (1)
"tunnelId": ...,
"clientMode": ...,
}
parent.rotate_tunnel_access_token(**kwargs)tag_resource#
A resource tag.
Type annotations and code completion for session.create_client("iotsecuretunneling").tag_resource method.
boto3 documentation
# tag_resource method definition
await def tag_resource(
self,
*,
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
) -> Dict[str, Any]:
...- See TagTypeDef
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tags": ...,
}
parent.tag_resource(**kwargs)untag_resource#
Removes a tag from a resource.
Type annotations and code completion for session.create_client("iotsecuretunneling").untag_resource method.
boto3 documentation
# untag_resource method definition
await def untag_resource(
self,
*,
resourceArn: str,
tagKeys: Sequence[str],
) -> Dict[str, Any]:
...# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"resourceArn": ...,
"tagKeys": ...,
}
parent.untag_resource(**kwargs)__aenter__#
Type annotations and code completion for session.create_client("iotsecuretunneling").__aenter__ method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> IoTSecureTunnelingClient:
...__aexit__#
Type annotations and code completion for session.create_client("iotsecuretunneling").__aexit__ method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...