Typed dictionaries

Index > IoTSecureTunneling > Typed dictionaries

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

CloseTunnelRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import CloseTunnelRequestRequestTypeDef

def get_value() -> CloseTunnelRequestRequestTypeDef:
    return {
        "tunnelId": ...,
    }

Definition

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

ConnectionStateTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import ConnectionStateTypeDef

def get_value() -> ConnectionStateTypeDef:
    return {
        "status": ...,
    }

Definition

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

1. See ConnectionStatusType

DescribeTunnelRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import DescribeTunnelRequestRequestTypeDef

def get_value() -> DescribeTunnelRequestRequestTypeDef:
    return {
        "tunnelId": ...,
    }

Definition

class DescribeTunnelRequestRequestTypeDef(TypedDict):
    tunnelId: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

DestinationConfigTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import DestinationConfigTypeDef

def get_value() -> DestinationConfigTypeDef:
    return {
        "services": ...,
    }

Definition

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

ListTagsForResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }

Definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

TagTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "key": ...,
        "value": ...,
    }

Definition

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

ListTunnelsRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import ListTunnelsRequestRequestTypeDef

def get_value() -> ListTunnelsRequestRequestTypeDef:
    return {
        "thingName": ...,
    }

Definition

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

TunnelSummaryTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import TunnelSummaryTypeDef

def get_value() -> TunnelSummaryTypeDef:
    return {
        "tunnelId": ...,
    }

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

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import TimeoutConfigTypeDef

def get_value() -> TimeoutConfigTypeDef:
    return {
        "maxLifetimeTimeoutMinutes": ...,
    }

Definition

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

UntagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }

Definition

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

OpenTunnelResponseTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import OpenTunnelResponseTypeDef

def get_value() -> OpenTunnelResponseTypeDef:
    return {
        "tunnelId": ...,
        "tunnelArn": ...,
        "sourceAccessToken": ...,
        "destinationAccessToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

RotateTunnelAccessTokenResponseTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import RotateTunnelAccessTokenResponseTypeDef

def get_value() -> RotateTunnelAccessTokenResponseTypeDef:
    return {
        "tunnelArn": ...,
        "sourceAccessToken": ...,
        "destinationAccessToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

RotateTunnelAccessTokenRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import RotateTunnelAccessTokenRequestRequestTypeDef

def get_value() -> RotateTunnelAccessTokenRequestRequestTypeDef:
    return {
        "tunnelId": ...,
        "clientMode": ...,
    }

Definition

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

1. See ClientModeType
2. See DestinationConfigTypeDef

ListTagsForResourceResponseTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See TagTypeDef
2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }

Definition

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

1. See TagTypeDef

ListTunnelsResponseTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import ListTunnelsResponseTypeDef

def get_value() -> ListTunnelsResponseTypeDef:
    return {
        "tunnelSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class ListTunnelsResponseTypeDef(TypedDict):
    tunnelSummaries: List[TunnelSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See TunnelSummaryTypeDef
2. See ResponseMetadataTypeDef

OpenTunnelRequestRequestTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import OpenTunnelRequestRequestTypeDef

def get_value() -> OpenTunnelRequestRequestTypeDef:
    return {
        "description": ...,
    }

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

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import TunnelTypeDef

def get_value() -> TunnelTypeDef:
    return {
        "tunnelId": ...,
    }

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],

1. See TunnelStatusType
2. See ConnectionStateTypeDef
3. See ConnectionStateTypeDef
4. See DestinationConfigTypeDef
5. See TimeoutConfigTypeDef
6. See TagTypeDef

DescribeTunnelResponseTypeDef

Usage Example

from mypy_boto3_iotsecuretunneling.type_defs import DescribeTunnelResponseTypeDef

def get_value() -> DescribeTunnelResponseTypeDef:
    return {
        "tunnel": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See TunnelTypeDef
2. See ResponseMetadataTypeDef