Skip to content

IoTDataPlane module#

Index > IoTDataPlane

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

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add IoTDataPlane service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and IoTDataPlane.

From PyPI with pip#

Install boto3-stubs for IoTDataPlane service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[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 'boto3-stubs-lite[iot-data]'

# standalone installation
python -m pip install mypy-boto3-iot-data

How to uninstall#

python -m pip uninstall -y mypy-boto3-iot-data

Usage#

Code samples can be found in Examples.

IoTDataPlaneClient#

Type annotations and code completion for boto3.client("iot-data") as IoTDataPlaneClient boto3 documentation

# IoTDataPlaneClient usage example

from boto3.session import Session

from mypy_boto3_iot_data.client import IoTDataPlaneClient

def get_client() -> IoTDataPlaneClient:
    return Session().client("iot-data")

Paginators#

Type annotations and code completion for paginators from boto3.client("iot-data").get_paginator("...").

# ListRetainedMessagesPaginator usage example

from boto3.session import Session

from mypy_boto3_iot_data.paginator import ListRetainedMessagesPaginator

def get_list_retained_messages_paginator() -> ListRetainedMessagesPaginator:
    return Session().client("iot-data").get_paginator("list_retained_messages"))

Literals#

Type annotations for literals used in methods and schema.

# ListRetainedMessagesPaginatorName usage example

from mypy_boto3_iot_data.literals import ListRetainedMessagesPaginatorName

def get_value() -> ListRetainedMessagesPaginatorName:
    return "list_retained_messages"

Type definitions#

Type annotations for type definitions used in methods and schema.