Skip to content

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

Usage example
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.

Usage example
client = boto3.client("iotsecuretunneling")

try:
    do_something(client)
except (
    client.ClientError,
    client.LimitExceededException,
    client.ResourceNotFoundException,
) as e:
    print(e)
Type checking example
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

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("iotsecuretunneling").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

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

Method definition
def close_tunnel(
    self,
    *,
    tunnelId: str,
    delete: bool = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CloseTunnelRequestRequestTypeDef = {  # (1)
    "tunnelId": ...,
}

parent.close_tunnel(**kwargs)
  1. See CloseTunnelRequestRequestTypeDef

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

Method definition
def describe_tunnel(
    self,
    *,
    tunnelId: str,
) -> DescribeTunnelResponseTypeDef:  # (1)
    ...
  1. See DescribeTunnelResponseTypeDef
Usage example with kwargs
kwargs: DescribeTunnelRequestRequestTypeDef = {  # (1)
    "tunnelId": ...,
}

parent.describe_tunnel(**kwargs)
  1. See DescribeTunnelRequestRequestTypeDef

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

Method definition
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

Method definition
def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

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

Method definition
def list_tunnels(
    self,
    *,
    thingName: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTunnelsResponseTypeDef:  # (1)
    ...
  1. See ListTunnelsResponseTypeDef
Usage example with kwargs
kwargs: ListTunnelsRequestRequestTypeDef = {  # (1)
    "thingName": ...,
}

parent.list_tunnels(**kwargs)
  1. See ListTunnelsRequestRequestTypeDef

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

Method definition
def open_tunnel(
    self,
    *,
    description: str = ...,
    tags: Sequence[TagTypeDef] = ...,  # (1)
    destinationConfig: DestinationConfigTypeDef = ...,  # (2)
    timeoutConfig: TimeoutConfigTypeDef = ...,  # (3)
) -> OpenTunnelResponseTypeDef:  # (4)
    ...
  1. See TagTypeDef
  2. See DestinationConfigTypeDef
  3. See TimeoutConfigTypeDef
  4. See OpenTunnelResponseTypeDef
Usage example with kwargs
kwargs: OpenTunnelRequestRequestTypeDef = {  # (1)
    "description": ...,
}

parent.open_tunnel(**kwargs)
  1. See OpenTunnelRequestRequestTypeDef

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

Method definition
def rotate_tunnel_access_token(
    self,
    *,
    tunnelId: str,
    clientMode: ClientModeType,  # (1)
    destinationConfig: DestinationConfigTypeDef = ...,  # (2)
) -> RotateTunnelAccessTokenResponseTypeDef:  # (3)
    ...
  1. See ClientModeType
  2. See DestinationConfigTypeDef
  3. See RotateTunnelAccessTokenResponseTypeDef
Usage example with kwargs
kwargs: RotateTunnelAccessTokenRequestRequestTypeDef = {  # (1)
    "tunnelId": ...,
    "clientMode": ...,
}

parent.rotate_tunnel_access_token(**kwargs)
  1. See RotateTunnelAccessTokenRequestRequestTypeDef

tag_resource

A resource tag.

Type annotations and code completion for boto3.client("iotsecuretunneling").tag_resource method. boto3 documentation

Method definition
def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef
Usage example with kwargs
kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource

Removes a tag from a resource.

Type annotations and code completion for boto3.client("iotsecuretunneling").untag_resource method. boto3 documentation

Method definition
def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef