Skip to content

Type definitions#

Index > IoTSecureTunneling > Type definitions

Auto-generated documentation for IoTSecureTunneling type annotations stubs module mypy-boto3-iotsecuretunneling.

CloseTunnelRequestRequestTypeDef#

# CloseTunnelRequestRequestTypeDef definition

class CloseTunnelRequestRequestTypeDef(TypedDict):
    tunnelId: str,
    delete: NotRequired[bool],

ConnectionStateTypeDef#

# ConnectionStateTypeDef definition

class ConnectionStateTypeDef(TypedDict):
    status: NotRequired[ConnectionStatusType],  # (1)
    lastUpdatedAt: NotRequired[datetime],
  1. See ConnectionStatusType

DescribeTunnelRequestRequestTypeDef#

# DescribeTunnelRequestRequestTypeDef definition

class DescribeTunnelRequestRequestTypeDef(TypedDict):
    tunnelId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

DestinationConfigOutputTypeDef#

# DestinationConfigOutputTypeDef definition

class DestinationConfigOutputTypeDef(TypedDict):
    services: list[str],
    thingName: NotRequired[str],

DestinationConfigTypeDef#

# DestinationConfigTypeDef definition

class DestinationConfigTypeDef(TypedDict):
    services: Sequence[str],
    thingName: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    key: str,
    value: str,

ListTunnelsRequestRequestTypeDef#

# ListTunnelsRequestRequestTypeDef definition

class ListTunnelsRequestRequestTypeDef(TypedDict):
    thingName: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

TunnelSummaryTypeDef#

# TunnelSummaryTypeDef definition

class TunnelSummaryTypeDef(TypedDict):
    tunnelId: NotRequired[str],
    tunnelArn: NotRequired[str],
    status: NotRequired[TunnelStatusType],  # (1)
    description: NotRequired[str],
    createdAt: NotRequired[datetime],
    lastUpdatedAt: NotRequired[datetime],
  1. See TunnelStatusType

TimeoutConfigTypeDef#

# TimeoutConfigTypeDef definition

class TimeoutConfigTypeDef(TypedDict):
    maxLifetimeTimeoutMinutes: NotRequired[int],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

OpenTunnelResponseTypeDef#

# OpenTunnelResponseTypeDef definition

class OpenTunnelResponseTypeDef(TypedDict):
    tunnelId: str,
    tunnelArn: str,
    sourceAccessToken: str,
    destinationAccessToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RotateTunnelAccessTokenResponseTypeDef#

# RotateTunnelAccessTokenResponseTypeDef definition

class RotateTunnelAccessTokenResponseTypeDef(TypedDict):
    tunnelArn: str,
    sourceAccessToken: str,
    destinationAccessToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

RotateTunnelAccessTokenRequestRequestTypeDef#

# RotateTunnelAccessTokenRequestRequestTypeDef definition

class RotateTunnelAccessTokenRequestRequestTypeDef(TypedDict):
    tunnelId: str,
    clientMode: ClientModeType,  # (1)
    destinationConfig: NotRequired[DestinationConfigTypeDef],  # (2)
  1. See ClientModeType
  2. See DestinationConfigTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ListTunnelsResponseTypeDef#

# ListTunnelsResponseTypeDef definition

class ListTunnelsResponseTypeDef(TypedDict):
    tunnelSummaries: list[TunnelSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See TunnelSummaryTypeDef
  2. See ResponseMetadataTypeDef

OpenTunnelRequestRequestTypeDef#

# OpenTunnelRequestRequestTypeDef definition

class OpenTunnelRequestRequestTypeDef(TypedDict):
    description: NotRequired[str],
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    destinationConfig: NotRequired[DestinationConfigTypeDef],  # (2)
    timeoutConfig: NotRequired[TimeoutConfigTypeDef],  # (3)
  1. See TagTypeDef
  2. See DestinationConfigTypeDef
  3. See TimeoutConfigTypeDef

TunnelTypeDef#

# 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[DestinationConfigOutputTypeDef],  # (4)
    timeoutConfig: NotRequired[TimeoutConfigTypeDef],  # (5)
    tags: NotRequired[list[TagTypeDef]],  # (6)
    createdAt: NotRequired[datetime],
    lastUpdatedAt: NotRequired[datetime],
  1. See TunnelStatusType
  2. See ConnectionStateTypeDef
  3. See ConnectionStateTypeDef
  4. See DestinationConfigOutputTypeDef
  5. See TimeoutConfigTypeDef
  6. See TagTypeDef

DescribeTunnelResponseTypeDef#

# DescribeTunnelResponseTypeDef definition

class DescribeTunnelResponseTypeDef(TypedDict):
    tunnel: TunnelTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TunnelTypeDef
  2. See ResponseMetadataTypeDef