Skip to content

Type definitions#

Index > IoTDataPlane > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

DeleteThingShadowRequestRequestTypeDef#

# DeleteThingShadowRequestRequestTypeDef definition

class DeleteThingShadowRequestRequestTypeDef(TypedDict):
    thingName: str,
    shadowName: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

GetRetainedMessageRequestRequestTypeDef#

# GetRetainedMessageRequestRequestTypeDef definition

class GetRetainedMessageRequestRequestTypeDef(TypedDict):
    topic: str,

GetThingShadowRequestRequestTypeDef#

# GetThingShadowRequestRequestTypeDef definition

class GetThingShadowRequestRequestTypeDef(TypedDict):
    thingName: str,
    shadowName: NotRequired[str],

ListNamedShadowsForThingRequestRequestTypeDef#

# ListNamedShadowsForThingRequestRequestTypeDef definition

class ListNamedShadowsForThingRequestRequestTypeDef(TypedDict):
    thingName: str,
    nextToken: NotRequired[str],
    pageSize: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListRetainedMessagesRequestRequestTypeDef#

# ListRetainedMessagesRequestRequestTypeDef definition

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

RetainedMessageSummaryTypeDef#

# RetainedMessageSummaryTypeDef definition

class RetainedMessageSummaryTypeDef(TypedDict):
    topic: NotRequired[str],
    payloadSize: NotRequired[int],
    qos: NotRequired[int],
    lastModifiedTime: NotRequired[int],

PublishRequestRequestTypeDef#

# 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],
  1. See PayloadFormatIndicatorType

UpdateThingShadowRequestRequestTypeDef#

# UpdateThingShadowRequestRequestTypeDef definition

class UpdateThingShadowRequestRequestTypeDef(TypedDict):
    thingName: str,
    payload: Union[str, bytes, IO[Any], StreamingBody],
    shadowName: NotRequired[str],

DeleteThingShadowResponseTypeDef#

# DeleteThingShadowResponseTypeDef definition

class DeleteThingShadowResponseTypeDef(TypedDict):
    payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetRetainedMessageResponseTypeDef#

# GetRetainedMessageResponseTypeDef definition

class GetRetainedMessageResponseTypeDef(TypedDict):
    topic: str,
    payload: bytes,
    qos: int,
    lastModifiedTime: int,
    userProperties: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetThingShadowResponseTypeDef#

# GetThingShadowResponseTypeDef definition

class GetThingShadowResponseTypeDef(TypedDict):
    payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListNamedShadowsForThingResponseTypeDef#

# ListNamedShadowsForThingResponseTypeDef definition

class ListNamedShadowsForThingResponseTypeDef(TypedDict):
    results: List[str],
    nextToken: str,
    timestamp: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateThingShadowResponseTypeDef#

# UpdateThingShadowResponseTypeDef definition

class UpdateThingShadowResponseTypeDef(TypedDict):
    payload: StreamingBody,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef#

# ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef definition

class ListRetainedMessagesRequestListRetainedMessagesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListRetainedMessagesResponseTypeDef#

# ListRetainedMessagesResponseTypeDef definition

class ListRetainedMessagesResponseTypeDef(TypedDict):
    retainedTopics: List[RetainedMessageSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RetainedMessageSummaryTypeDef
  2. See ResponseMetadataTypeDef