Type definitions#
Index > IoTDataPlane > Type definitions
Auto-generated documentation for IoTDataPlane type annotations stubs module mypy-boto3-iot-data.
BlobTypeDef#
# BlobTypeDef Union usage example
from mypy_boto3_iot_data.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
botocore.response.StreamingBody,
]
DeleteThingShadowRequestTypeDef#
# DeleteThingShadowRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import DeleteThingShadowRequestTypeDef
def get_value() -> DeleteThingShadowRequestTypeDef:
return {
"thingName": ...,
}
# DeleteThingShadowRequestTypeDef definition
class DeleteThingShadowRequestTypeDef(TypedDict):
thingName: str,
shadowName: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
GetRetainedMessageRequestTypeDef#
# GetRetainedMessageRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import GetRetainedMessageRequestTypeDef
def get_value() -> GetRetainedMessageRequestTypeDef:
return {
"topic": ...,
}
# GetRetainedMessageRequestTypeDef definition
class GetRetainedMessageRequestTypeDef(TypedDict):
topic: str,
GetThingShadowRequestTypeDef#
# GetThingShadowRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import GetThingShadowRequestTypeDef
def get_value() -> GetThingShadowRequestTypeDef:
return {
"thingName": ...,
}
# GetThingShadowRequestTypeDef definition
class GetThingShadowRequestTypeDef(TypedDict):
thingName: str,
shadowName: NotRequired[str],
ListNamedShadowsForThingRequestTypeDef#
# ListNamedShadowsForThingRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import ListNamedShadowsForThingRequestTypeDef
def get_value() -> ListNamedShadowsForThingRequestTypeDef:
return {
"thingName": ...,
}
# ListNamedShadowsForThingRequestTypeDef definition
class ListNamedShadowsForThingRequestTypeDef(TypedDict):
thingName: str,
nextToken: NotRequired[str],
pageSize: NotRequired[int],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict 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],
ListRetainedMessagesRequestTypeDef#
# ListRetainedMessagesRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesRequestTypeDef
def get_value() -> ListRetainedMessagesRequestTypeDef:
return {
"nextToken": ...,
}
# ListRetainedMessagesRequestTypeDef definition
class ListRetainedMessagesRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
RetainedMessageSummaryTypeDef#
# RetainedMessageSummaryTypeDef TypedDict 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],
PublishRequestTypeDef#
# PublishRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import PublishRequestTypeDef
def get_value() -> PublishRequestTypeDef:
return {
"topic": ...,
}
# PublishRequestTypeDef definition
class PublishRequestTypeDef(TypedDict):
topic: str,
qos: NotRequired[int],
retain: NotRequired[bool],
payload: NotRequired[BlobTypeDef],
userProperties: NotRequired[str],
payloadFormatIndicator: NotRequired[PayloadFormatIndicatorType], # (1)
contentType: NotRequired[str],
responseTopic: NotRequired[str],
correlationData: NotRequired[str],
messageExpiry: NotRequired[int],
UpdateThingShadowRequestTypeDef#
# UpdateThingShadowRequestTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import UpdateThingShadowRequestTypeDef
def get_value() -> UpdateThingShadowRequestTypeDef:
return {
"thingName": ...,
}
# UpdateThingShadowRequestTypeDef definition
class UpdateThingShadowRequestTypeDef(TypedDict):
thingName: str,
payload: BlobTypeDef,
shadowName: NotRequired[str],
DeleteThingShadowResponseTypeDef#
# DeleteThingShadowResponseTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import DeleteThingShadowResponseTypeDef
def get_value() -> DeleteThingShadowResponseTypeDef:
return {
"payload": ...,
}
# DeleteThingShadowResponseTypeDef definition
class DeleteThingShadowResponseTypeDef(TypedDict):
payload: botocore.response.StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict 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)
GetRetainedMessageResponseTypeDef#
# GetRetainedMessageResponseTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import GetRetainedMessageResponseTypeDef
def get_value() -> GetRetainedMessageResponseTypeDef:
return {
"topic": ...,
}
# GetRetainedMessageResponseTypeDef definition
class GetRetainedMessageResponseTypeDef(TypedDict):
topic: str,
payload: bytes,
qos: int,
lastModifiedTime: int,
userProperties: bytes,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetThingShadowResponseTypeDef#
# GetThingShadowResponseTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import GetThingShadowResponseTypeDef
def get_value() -> GetThingShadowResponseTypeDef:
return {
"payload": ...,
}
# GetThingShadowResponseTypeDef definition
class GetThingShadowResponseTypeDef(TypedDict):
payload: botocore.response.StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListNamedShadowsForThingResponseTypeDef#
# ListNamedShadowsForThingResponseTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import ListNamedShadowsForThingResponseTypeDef
def get_value() -> ListNamedShadowsForThingResponseTypeDef:
return {
"results": ...,
}
# ListNamedShadowsForThingResponseTypeDef definition
class ListNamedShadowsForThingResponseTypeDef(TypedDict):
results: List[str],
timestamp: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
nextToken: NotRequired[str],
UpdateThingShadowResponseTypeDef#
# UpdateThingShadowResponseTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import UpdateThingShadowResponseTypeDef
def get_value() -> UpdateThingShadowResponseTypeDef:
return {
"payload": ...,
}
# UpdateThingShadowResponseTypeDef definition
class UpdateThingShadowResponseTypeDef(TypedDict):
payload: botocore.response.StreamingBody,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListRetainedMessagesRequestPaginateTypeDef#
# ListRetainedMessagesRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesRequestPaginateTypeDef
def get_value() -> ListRetainedMessagesRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListRetainedMessagesRequestPaginateTypeDef definition
class ListRetainedMessagesRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListRetainedMessagesResponseTypeDef#
# ListRetainedMessagesResponseTypeDef TypedDict usage example
from mypy_boto3_iot_data.type_defs import ListRetainedMessagesResponseTypeDef
def get_value() -> ListRetainedMessagesResponseTypeDef:
return {
"retainedTopics": ...,
}
# ListRetainedMessagesResponseTypeDef definition
class ListRetainedMessagesResponseTypeDef(TypedDict):
retainedTopics: List[RetainedMessageSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[RetainedMessageSummaryTypeDef]
- See ResponseMetadataTypeDef