Skip to content

IoT module#

Index > IoT

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

How to install#

VSCode extension#

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

Click Modify and select boto3 common and IoT.

From PyPI with pip#

Install boto3-stubs for IoT service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[iot]'


# 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]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

IoTClient#

Type annotations and code completion for boto3.client("iot") as IoTClient boto3 documentation

# IoTClient usage example

from boto3.session import Session

from mypy_boto3_iot.client import IoTClient

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

Paginators#

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

# GetBehaviorModelTrainingSummariesPaginator usage example

from boto3.session import Session

from mypy_boto3_iot.paginator import GetBehaviorModelTrainingSummariesPaginator

def get_get_behavior_model_training_summaries_paginator() -> GetBehaviorModelTrainingSummariesPaginator:
    return Session().client("iot").get_paginator("get_behavior_model_training_summaries"))

Literals#

Type annotations for literals used in methods and schemas.

# AbortActionType usage example

from mypy_boto3_iot.literals import AbortActionType

def get_value() -> AbortActionType:
    return "CANCEL"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AbortCriteriaTypeDef usage example

from mypy_boto3_iot.type_defs import AbortCriteriaTypeDef

def get_value() -> AbortCriteriaTypeDef:
    return {
        "failureType": ...,
        "action": ...,
        "thresholdPercentage": ...,
        "minNumberOfExecutedThings": ...,
    }