Skip to content

Typed dictionaries

Index > IoTDataPlane > Typed dictionaries

Auto-generated documentation for IoTDataPlane type annotations stubs module mypy-boto3-iot-data.

DeleteThingShadowRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import DeleteThingShadowRequestRequestTypeDef

def get_value() -> DeleteThingShadowRequestRequestTypeDef:
    return {
        "thingName": ...,
    }
Definition
class DeleteThingShadowRequestRequestTypeDef(TypedDict):
    thingName: str,
    shadowName: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_iot_data.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,

GetRetainedMessageRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import GetRetainedMessageRequestRequestTypeDef

def get_value() -> GetRetainedMessageRequestRequestTypeDef:
    return {
        "topic": ...,
    }
Definition
class GetRetainedMessageRequestRequestTypeDef(TypedDict):
    topic: str,

GetThingShadowRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import GetThingShadowRequestRequestTypeDef

def get_value() -> GetThingShadowRequestRequestTypeDef:
    return {
        "thingName": ...,
    }
Definition
class GetThingShadowRequestRequestTypeDef(TypedDict):
    thingName: str,
    shadowName: NotRequired[str],

ListNamedShadowsForThingRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import ListNamedShadowsForThingRequestRequestTypeDef

def get_value() -> ListNamedShadowsForThingRequestRequestTypeDef:
    return {
        "thingName": ...,
    }
Definition
class ListNamedShadowsForThingRequestRequestTypeDef(TypedDict):
    thingName: str,
    nextToken: NotRequired[str],
    pageSize: NotRequired[int],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListRetainedMessagesRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesRequestRequestTypeDef

def get_value() -> ListRetainedMessagesRequestRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListRetainedMessagesRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

RetainedMessageSummaryTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import RetainedMessageSummaryTypeDef

def get_value() -> RetainedMessageSummaryTypeDef:
    return {
        "topic": ...,
    }
Definition
class RetainedMessageSummaryTypeDef(TypedDict):
    topic: NotRequired[str],
    payloadSize: NotRequired[int],
    qos: NotRequired[int],
    lastModifiedTime: NotRequired[int],

PublishRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import PublishRequestRequestTypeDef

def get_value() -> PublishRequestRequestTypeDef:
    return {
        "topic": ...,
    }
Definition
class PublishRequestRequestTypeDef(TypedDict):
    topic: str,
    qos: NotRequired[int],
    retain: NotRequired[bool],
    payload: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],

UpdateThingShadowRequestRequestTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import UpdateThingShadowRequestRequestTypeDef

def get_value() -> UpdateThingShadowRequestRequestTypeDef:
    return {
        "thingName": ...,
        "payload": ...,
    }
Definition
class UpdateThingShadowRequestRequestTypeDef(TypedDict):
    thingName: str,
    payload: Union[str, bytes, IO[Any], StreamingBody],
    shadowName: NotRequired[str],

DeleteThingShadowResponseTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import DeleteThingShadowResponseTypeDef

def get_value() -> DeleteThingShadowResponseTypeDef:
    return {
        "payload": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteThingShadowResponseTypeDef(TypedDict):
    payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRetainedMessageResponseTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import GetRetainedMessageResponseTypeDef

def get_value() -> GetRetainedMessageResponseTypeDef:
    return {
        "topic": ...,
        "payload": ...,
        "qos": ...,
        "lastModifiedTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetRetainedMessageResponseTypeDef(TypedDict):
    topic: str,
    payload: bytes,
    qos: int,
    lastModifiedTime: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetThingShadowResponseTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import GetThingShadowResponseTypeDef

def get_value() -> GetThingShadowResponseTypeDef:
    return {
        "payload": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetThingShadowResponseTypeDef(TypedDict):
    payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListNamedShadowsForThingResponseTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import ListNamedShadowsForThingResponseTypeDef

def get_value() -> ListNamedShadowsForThingResponseTypeDef:
    return {
        "results": ...,
        "nextToken": ...,
        "timestamp": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListNamedShadowsForThingResponseTypeDef(TypedDict):
    results: List[str],
    nextToken: str,
    timestamp: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateThingShadowResponseTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import UpdateThingShadowResponseTypeDef

def get_value() -> UpdateThingShadowResponseTypeDef:
    return {
        "payload": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateThingShadowResponseTypeDef(TypedDict):
    payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef

def get_value() -> ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRetainedMessagesResponseTypeDef

Usage Example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesResponseTypeDef

def get_value() -> ListRetainedMessagesResponseTypeDef:
    return {
        "retainedTopics": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListRetainedMessagesResponseTypeDef(TypedDict):
    retainedTopics: List[RetainedMessageSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RetainedMessageSummaryTypeDef
  2. See ResponseMetadataTypeDef