IoTAnalytics module#
Index > IoTAnalytics
Auto-generated documentation for IoTAnalytics type annotations stubs module mypy-boto3-iotanalytics.
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
IoTAnalytics
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 IoTAnalytics
.
From PyPI with pip#
Install boto3-stubs
for IoTAnalytics
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[iotanalytics]'
# 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[iotanalytics]'
# standalone installation
python -m pip install mypy-boto3-iotanalytics
How to uninstall#
python -m pip uninstall -y mypy-boto3-iotanalytics
Usage#
Code samples can be found in Examples.
IoTAnalyticsClient#
Type annotations and code completion for boto3.client("iotanalytics")
as IoTAnalyticsClient
boto3 documentation
# IoTAnalyticsClient usage example
from boto3.session import Session
from mypy_boto3_iotanalytics.client import IoTAnalyticsClient
def get_client() -> IoTAnalyticsClient:
return Session().client("iotanalytics")
Paginators#
Type annotations and code completion for paginators
from boto3.client("iotanalytics").get_paginator("...")
.
# ListChannelsPaginator usage example
from boto3.session import Session
from mypy_boto3_iotanalytics.paginator import ListChannelsPaginator
def get_list_channels_paginator() -> ListChannelsPaginator:
return Session().client("iotanalytics").get_paginator("list_channels"))
- ListChannelsPaginator
- ListDatasetContentsPaginator
- ListDatasetsPaginator
- ListDatastoresPaginator
- ListPipelinesPaginator
Literals#
Type annotations for literals used in methods and schema.
# ChannelStatusType usage example
from mypy_boto3_iotanalytics.literals import ChannelStatusType
def get_value() -> ChannelStatusType:
return "ACTIVE"