Typed dictionaries#
Index > IoTDataPlane > Typed dictionaries
Auto-generated documentation for IoTDataPlane type annotations stubs module mypy-boto3-iot-data.
DeleteThingShadowRequestRequestTypeDef#
# DeleteThingShadowRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import DeleteThingShadowRequestRequestTypeDef
def get_value() -> DeleteThingShadowRequestRequestTypeDef:
return {
"thingName": ...,
}
# DeleteThingShadowRequestRequestTypeDef definition
class DeleteThingShadowRequestRequestTypeDef(TypedDict):
thingName: str,
shadowName: NotRequired[str],
DeleteThingShadowResponseTypeDef#
# DeleteThingShadowResponseTypeDef usage example
from mypy_boto3_iot_data.type_defs import DeleteThingShadowResponseTypeDef
def get_value() -> DeleteThingShadowResponseTypeDef:
return {
"payload": ...,
"ResponseMetadata": ...,
}
# DeleteThingShadowResponseTypeDef definition
class DeleteThingShadowResponseTypeDef(TypedDict):
payload: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_iot_data.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetRetainedMessageRequestRequestTypeDef#
# GetRetainedMessageRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import GetRetainedMessageRequestRequestTypeDef
def get_value() -> GetRetainedMessageRequestRequestTypeDef:
return {
"topic": ...,
}
# GetRetainedMessageRequestRequestTypeDef definition
class GetRetainedMessageRequestRequestTypeDef(TypedDict):
topic: str,
GetRetainedMessageResponseTypeDef#
# GetRetainedMessageResponseTypeDef usage example
from mypy_boto3_iot_data.type_defs import GetRetainedMessageResponseTypeDef
def get_value() -> GetRetainedMessageResponseTypeDef:
return {
"topic": ...,
"payload": ...,
"qos": ...,
"lastModifiedTime": ...,
"userProperties": ...,
"ResponseMetadata": ...,
}
# GetRetainedMessageResponseTypeDef definition
class GetRetainedMessageResponseTypeDef(TypedDict):
topic: str,
payload: bytes,
qos: int,
lastModifiedTime: int,
userProperties: bytes,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetThingShadowRequestRequestTypeDef#
# GetThingShadowRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import GetThingShadowRequestRequestTypeDef
def get_value() -> GetThingShadowRequestRequestTypeDef:
return {
"thingName": ...,
}
# GetThingShadowRequestRequestTypeDef definition
class GetThingShadowRequestRequestTypeDef(TypedDict):
thingName: str,
shadowName: NotRequired[str],
GetThingShadowResponseTypeDef#
# GetThingShadowResponseTypeDef usage example
from mypy_boto3_iot_data.type_defs import GetThingShadowResponseTypeDef
def get_value() -> GetThingShadowResponseTypeDef:
return {
"payload": ...,
"ResponseMetadata": ...,
}
# GetThingShadowResponseTypeDef definition
class GetThingShadowResponseTypeDef(TypedDict):
payload: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListNamedShadowsForThingRequestRequestTypeDef#
# ListNamedShadowsForThingRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import ListNamedShadowsForThingRequestRequestTypeDef
def get_value() -> ListNamedShadowsForThingRequestRequestTypeDef:
return {
"thingName": ...,
}
# ListNamedShadowsForThingRequestRequestTypeDef definition
class ListNamedShadowsForThingRequestRequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
pageSize: NotRequired[int],
ListNamedShadowsForThingResponseTypeDef#
# ListNamedShadowsForThingResponseTypeDef usage example
from mypy_boto3_iot_data.type_defs import ListNamedShadowsForThingResponseTypeDef
def get_value() -> ListNamedShadowsForThingResponseTypeDef:
return {
"results": ...,
"nextToken": ...,
"timestamp": ...,
"ResponseMetadata": ...,
}
# ListNamedShadowsForThingResponseTypeDef definition
class ListNamedShadowsForThingResponseTypeDef(TypedDict):
results: List[str],
nextToken: str,
timestamp: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef#
# ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef usage example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef
def get_value() -> ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef definition
class ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRetainedMessagesRequestRequestTypeDef#
# ListRetainedMessagesRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesRequestRequestTypeDef
def get_value() -> ListRetainedMessagesRequestRequestTypeDef:
return {
"nextToken": ...,
}
# ListRetainedMessagesRequestRequestTypeDef definition
class ListRetainedMessagesRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
RetainedMessageSummaryTypeDef#
# RetainedMessageSummaryTypeDef usage example
from mypy_boto3_iot_data.type_defs import RetainedMessageSummaryTypeDef
def get_value() -> RetainedMessageSummaryTypeDef:
return {
"topic": ...,
}
# RetainedMessageSummaryTypeDef definition
class RetainedMessageSummaryTypeDef(TypedDict):
topic: NotRequired[str],
payloadSize: NotRequired[int],
qos: NotRequired[int],
lastModifiedTime: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_iot_data.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
PublishRequestRequestTypeDef#
# PublishRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import PublishRequestRequestTypeDef
def get_value() -> PublishRequestRequestTypeDef:
return {
"topic": ...,
}
# PublishRequestRequestTypeDef definition
class PublishRequestRequestTypeDef(TypedDict):
topic: str,
qos: NotRequired[int],
retain: NotRequired[bool],
payload: NotRequired[Union[str, bytes, IO[Any], StreamingBody]],
userProperties: NotRequired[str],
payloadFormatIndicator: NotRequired[PayloadFormatIndicatorType], # (1)
contentType: NotRequired[str],
responseTopic: NotRequired[str],
correlationData: NotRequired[str],
messageExpiry: NotRequired[int],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_iot_data.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,
UpdateThingShadowRequestRequestTypeDef#
# UpdateThingShadowRequestRequestTypeDef usage example
from mypy_boto3_iot_data.type_defs import UpdateThingShadowRequestRequestTypeDef
def get_value() -> UpdateThingShadowRequestRequestTypeDef:
return {
"thingName": ...,
"payload": ...,
}
# UpdateThingShadowRequestRequestTypeDef definition
class UpdateThingShadowRequestRequestTypeDef(TypedDict):
thingName: str,
payload: Union[str, bytes, IO[Any], StreamingBody],
shadowName: NotRequired[str],
UpdateThingShadowResponseTypeDef#
# UpdateThingShadowResponseTypeDef usage example
from mypy_boto3_iot_data.type_defs import UpdateThingShadowResponseTypeDef
def get_value() -> UpdateThingShadowResponseTypeDef:
return {
"payload": ...,
"ResponseMetadata": ...,
}
# UpdateThingShadowResponseTypeDef definition
class UpdateThingShadowResponseTypeDef(TypedDict):
payload: StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListRetainedMessagesResponseTypeDef#
# ListRetainedMessagesResponseTypeDef usage example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesResponseTypeDef
def get_value() -> ListRetainedMessagesResponseTypeDef:
return {
"retainedTopics": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListRetainedMessagesResponseTypeDef definition
class ListRetainedMessagesResponseTypeDef(TypedDict):
retainedTopics: List[RetainedMessageSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)