Skip to content

Examples#

Index > IoTDataPlane > Examples

Auto-generated documentation for IoTDataPlane type annotations stubs module types-aiobotocore-iot-data.

Client#

Implicit type annotations#

Can be used with types-aiobotocore[iot-data] package installed.

Write your IoTDataPlane code as usual, type checking and code completion should work out of the box.

Client method usage example#

# IoTDataPlaneClient usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("iot-data") as client:  # (1)
    result = await client.delete_thing_shadow()  # (2)
  1. client: IoTDataPlaneClient
  2. result: DeleteThingShadowResponseTypeDef

Paginator usage example#

# ListRetainedMessagesPaginator usage example

from aiobotocore.session import get_session


session = get_session()

async with session.create_client("iot-data") as client:  # (1)
    paginator = client.get_paginator("list_retained_messages")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: IoTDataPlaneClient
  2. paginator: ListRetainedMessagesPaginator
  3. item: ListRetainedMessagesResponseTypeDef

Explicit type annotations#

With types-aiobotocore-lite[iot-data] or a standalone types_aiobotocore_iot_data package, you have to explicitly specify client: IoTDataPlaneClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example#

# IoTDataPlaneClient usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_iot_data.client import IoTDataPlaneClient
from types_aiobotocore_iot_data.type_defs import DeleteThingShadowResponseTypeDef
from types_aiobotocore_iot_data.type_defs import DeleteThingShadowRequestTypeDef


session = get_session()

async with session.create_client("iot-data") as client:
    client: IoTDataPlaneClient
    kwargs: DeleteThingShadowRequestTypeDef = {...}
    result: DeleteThingShadowResponseTypeDef = await client.delete_thing_shadow(**kwargs)

Paginator usage example#

# ListRetainedMessagesPaginator usage example with type annotations

from aiobotocore.session import get_session

from types_aiobotocore_iot_data.client import IoTDataPlaneClient
from types_aiobotocore_iot_data.paginator import ListRetainedMessagesPaginator
from types_aiobotocore_iot_data.type_defs import ListRetainedMessagesResponseTypeDef


session = get_session()

async with session.create_client("iot-data") as client:
    client: IoTDataPlaneClient
    paginator: ListRetainedMessagesPaginator = client.get_paginator("list_retained_messages")
    async for item in paginator.paginate(...):
        item: ListRetainedMessagesResponseTypeDef
        print(item)