Skip to content

IoTEvents module#

Index > IoTEvents

Auto-generated documentation for IoTEvents type annotations stubs module mypy-boto3-iotevents.

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 IoTEvents.

From PyPI with pip#

Install boto3-stubs for IoTEvents service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

IoTEventsClient#

Type annotations and code completion for boto3.client("iotevents") as IoTEventsClient boto3 documentation

# IoTEventsClient usage example

from boto3.session import Session

from mypy_boto3_iotevents.client import IoTEventsClient

def get_client() -> IoTEventsClient:
    return Session().client("iotevents")

Literals#

Type annotations for literals used in methods and schemas.

# AlarmModelVersionStatusType usage example

from mypy_boto3_iotevents.literals import AlarmModelVersionStatusType

def get_value() -> AlarmModelVersionStatusType:
    return "ACTIVATING"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcknowledgeFlowTypeDef usage example

from mypy_boto3_iotevents.type_defs import AcknowledgeFlowTypeDef

def get_value() -> AcknowledgeFlowTypeDef:
    return {
        "enabled": ...,
    }