Typed dictionaries#
Index > IoTSecureTunneling > Typed dictionaries
Auto-generated documentation for IoTSecureTunneling type annotations stubs module mypy-boto3-iotsecuretunneling.
CloseTunnelRequestRequestTypeDef#
# CloseTunnelRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import CloseTunnelRequestRequestTypeDef
def get_value() -> CloseTunnelRequestRequestTypeDef:
return {
"tunnelId": ...,
}
# CloseTunnelRequestRequestTypeDef definition
class CloseTunnelRequestRequestTypeDef(TypedDict):
tunnelId: str,
delete: NotRequired[bool],
ConnectionStateTypeDef#
# ConnectionStateTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import ConnectionStateTypeDef
def get_value() -> ConnectionStateTypeDef:
return {
"status": ...,
}
# ConnectionStateTypeDef definition
class ConnectionStateTypeDef(TypedDict):
status: NotRequired[ConnectionStatusType], # (1)
lastUpdatedAt: NotRequired[datetime],
DescribeTunnelRequestRequestTypeDef#
# DescribeTunnelRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import DescribeTunnelRequestRequestTypeDef
def get_value() -> DescribeTunnelRequestRequestTypeDef:
return {
"tunnelId": ...,
}
# DescribeTunnelRequestRequestTypeDef definition
class DescribeTunnelRequestRequestTypeDef(TypedDict):
tunnelId: str,
DestinationConfigTypeDef#
# DestinationConfigTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import DestinationConfigTypeDef
def get_value() -> DestinationConfigTypeDef:
return {
"services": ...,
}
# DestinationConfigTypeDef definition
class DestinationConfigTypeDef(TypedDict):
services: List[str],
thingName: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
TagTypeDef#
# TagTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
"value": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,
ListTunnelsRequestRequestTypeDef#
# ListTunnelsRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import ListTunnelsRequestRequestTypeDef
def get_value() -> ListTunnelsRequestRequestTypeDef:
return {
"thingName": ...,
}
# ListTunnelsRequestRequestTypeDef definition
class ListTunnelsRequestRequestTypeDef(TypedDict):
thingName: NotRequired[str],
maxResults: NotRequired[int],
nextToken: NotRequired[str],
TunnelSummaryTypeDef#
# TunnelSummaryTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import TunnelSummaryTypeDef
def get_value() -> TunnelSummaryTypeDef:
return {
"tunnelId": ...,
}
# TunnelSummaryTypeDef definition
class TunnelSummaryTypeDef(TypedDict):
tunnelId: NotRequired[str],
tunnelArn: NotRequired[str],
status: NotRequired[TunnelStatusType], # (1)
description: NotRequired[str],
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
- See TunnelStatusType
TimeoutConfigTypeDef#
# TimeoutConfigTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import TimeoutConfigTypeDef
def get_value() -> TimeoutConfigTypeDef:
return {
"maxLifetimeTimeoutMinutes": ...,
}
# TimeoutConfigTypeDef definition
class TimeoutConfigTypeDef(TypedDict):
maxLifetimeTimeoutMinutes: NotRequired[int],
OpenTunnelResponseTypeDef#
# OpenTunnelResponseTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import OpenTunnelResponseTypeDef
def get_value() -> OpenTunnelResponseTypeDef:
return {
"tunnelId": ...,
"tunnelArn": ...,
"sourceAccessToken": ...,
"destinationAccessToken": ...,
"ResponseMetadata": ...,
}
# OpenTunnelResponseTypeDef definition
class OpenTunnelResponseTypeDef(TypedDict):
tunnelId: str,
tunnelArn: str,
sourceAccessToken: str,
destinationAccessToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
RotateTunnelAccessTokenResponseTypeDef#
# RotateTunnelAccessTokenResponseTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import RotateTunnelAccessTokenResponseTypeDef
def get_value() -> RotateTunnelAccessTokenResponseTypeDef:
return {
"tunnelArn": ...,
"sourceAccessToken": ...,
"destinationAccessToken": ...,
"ResponseMetadata": ...,
}
# RotateTunnelAccessTokenResponseTypeDef definition
class RotateTunnelAccessTokenResponseTypeDef(TypedDict):
tunnelArn: str,
sourceAccessToken: str,
destinationAccessToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
RotateTunnelAccessTokenRequestRequestTypeDef#
# RotateTunnelAccessTokenRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import RotateTunnelAccessTokenRequestRequestTypeDef
def get_value() -> RotateTunnelAccessTokenRequestRequestTypeDef:
return {
"tunnelId": ...,
"clientMode": ...,
}
# RotateTunnelAccessTokenRequestRequestTypeDef definition
class RotateTunnelAccessTokenRequestRequestTypeDef(TypedDict):
tunnelId: str,
clientMode: ClientModeType, # (1)
destinationConfig: NotRequired[DestinationConfigTypeDef], # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ListTunnelsResponseTypeDef#
# ListTunnelsResponseTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import ListTunnelsResponseTypeDef
def get_value() -> ListTunnelsResponseTypeDef:
return {
"tunnelSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListTunnelsResponseTypeDef definition
class ListTunnelsResponseTypeDef(TypedDict):
tunnelSummaries: List[TunnelSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
OpenTunnelRequestRequestTypeDef#
# OpenTunnelRequestRequestTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import OpenTunnelRequestRequestTypeDef
def get_value() -> OpenTunnelRequestRequestTypeDef:
return {
"description": ...,
}
# OpenTunnelRequestRequestTypeDef definition
class OpenTunnelRequestRequestTypeDef(TypedDict):
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (1)
destinationConfig: NotRequired[DestinationConfigTypeDef], # (2)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (3)
- See TagTypeDef
- See DestinationConfigTypeDef
- See TimeoutConfigTypeDef
TunnelTypeDef#
# TunnelTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import TunnelTypeDef
def get_value() -> TunnelTypeDef:
return {
"tunnelId": ...,
}
# TunnelTypeDef definition
class TunnelTypeDef(TypedDict):
tunnelId: NotRequired[str],
tunnelArn: NotRequired[str],
status: NotRequired[TunnelStatusType], # (1)
sourceConnectionState: NotRequired[ConnectionStateTypeDef], # (2)
destinationConnectionState: NotRequired[ConnectionStateTypeDef], # (2)
description: NotRequired[str],
destinationConfig: NotRequired[DestinationConfigTypeDef], # (4)
timeoutConfig: NotRequired[TimeoutConfigTypeDef], # (5)
tags: NotRequired[List[TagTypeDef]], # (6)
createdAt: NotRequired[datetime],
lastUpdatedAt: NotRequired[datetime],
- See TunnelStatusType
- See ConnectionStateTypeDef
- See ConnectionStateTypeDef
- See DestinationConfigTypeDef
- See TimeoutConfigTypeDef
- See TagTypeDef
DescribeTunnelResponseTypeDef#
# DescribeTunnelResponseTypeDef usage example
from mypy_boto3_iotsecuretunneling.type_defs import DescribeTunnelResponseTypeDef
def get_value() -> DescribeTunnelResponseTypeDef:
return {
"tunnel": ...,
"ResponseMetadata": ...,
}
# DescribeTunnelResponseTypeDef definition
class DescribeTunnelResponseTypeDef(TypedDict):
tunnel: TunnelTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TunnelTypeDef
- See ResponseMetadataTypeDef