IoTEvents module#
Index > IoTEvents
Auto-generated documentation for IoTEvents type annotations stubs module mypy-boto3-iotevents.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.2' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
IoTEvents
service. - 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 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 schema.
# AlarmModelVersionStatusType usage example
from mypy_boto3_iotevents.literals import AlarmModelVersionStatusType
def get_value() -> AlarmModelVersionStatusType:
return "ACTIVATING"
- AlarmModelVersionStatusType
- AnalysisResultLevelType
- AnalysisStatusType
- ComparisonOperatorType
- DetectorModelVersionStatusType
- EvaluationMethodType
- InputStatusType
- LoggingLevelType
- PayloadTypeType
- IoTEventsServiceName
- ServiceName
- ResourceServiceName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AcknowledgeFlowTypeDef
- ClearTimerActionTypeDef
- ResetTimerActionTypeDef
- SetTimerActionTypeDef
- SetVariableActionTypeDef
- InitializationConfigurationTypeDef
- AlarmModelSummaryTypeDef
- AlarmModelVersionSummaryTypeDef
- SimpleRuleTypeDef
- AnalysisResultLocationTypeDef
- AssetPropertyTimestampTypeDef
- AssetPropertyVariantTypeDef
- AttributeTypeDef