IoTDataPlane module#
Index > IoTDataPlane
Auto-generated documentation for IoTDataPlane type annotations stubs module types-aiobotocore-iot-data.
How to install#
Generate locally (recommended)#
You can generate type annotations for aiobotocore
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'aiobotocore==2.23.0' mypy-boto3-builder
- Select
aiobotocore
AWS SDK. - Add
IoTDataPlane
service. - Use provided commands to install generated packages.
From PyPI with pip#
Install types-aiobotocore
for IoTDataPlane
service.
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[iot-data]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[iot-data]'
# standalone installation
python -m pip install types-aiobotocore-iot-data
How to uninstall#
python -m pip uninstall -y types-aiobotocore-iot-data
Usage#
Code samples can be found in Examples.
IoTDataPlaneClient#
Type annotations and code completion for session.create_client("iot-data")
as IoTDataPlaneClient
boto3 documentation
# IoTDataPlaneClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_iot_data.client import IoTDataPlaneClient
session = get_session()
async with session.create_client("iot-data") as client:
client: IoTDataPlaneClient
Paginators#
Type annotations and code completion for
paginators
from session.create_client("iot-data").get_paginator("...")
.
# ListRetainedMessagesPaginator usage example
from types_aiobotocore_iot_data.paginator import ListRetainedMessagesPaginator
def get_list_retained_messages_paginator() -> ListRetainedMessagesPaginator:
return client.get_paginator("list_retained_messages"))
Literals#
Type annotations for literals used in methods and schema.
# ListRetainedMessagesPaginatorName usage example
from types_aiobotocore_iot_data.literals import ListRetainedMessagesPaginatorName
def get_value() -> ListRetainedMessagesPaginatorName:
return "list_retained_messages"
- ListRetainedMessagesPaginatorName
- PayloadFormatIndicatorType
- IoTDataPlaneServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- BlobTypeDef
- DeleteThingShadowRequestTypeDef
- ResponseMetadataTypeDef
- GetRetainedMessageRequestTypeDef
- GetThingShadowRequestTypeDef
- ListNamedShadowsForThingRequestTypeDef
- PaginatorConfigTypeDef
- ListRetainedMessagesRequestTypeDef
- RetainedMessageSummaryTypeDef
- PublishRequestTypeDef
- UpdateThingShadowRequestTypeDef
- DeleteThingShadowResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetRetainedMessageResponseTypeDef
- GetThingShadowResponseTypeDef
- ListNamedShadowsForThingResponseTypeDef
- UpdateThingShadowResponseTypeDef
- ListRetainedMessagesRequestPaginateTypeDef
- ListRetainedMessagesResponseTypeDef