Skip to content

IoTSiteWise module#

Index > IoTSiteWise

Auto-generated documentation for IoTSiteWise type annotations stubs module mypy-boto3-iotsitewise.

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.43.71' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add IoTSiteWise service.
  4. 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 IoTSiteWise.

From PyPI with pip#

Install boto3-stubs for IoTSiteWise service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

IoTSiteWiseClient#

Type annotations and code completion for boto3.client("iotsitewise") as IoTSiteWiseClient boto3 documentation

# IoTSiteWiseClient usage example

from boto3.session import Session

from mypy_boto3_iotsitewise.client import IoTSiteWiseClient

def get_client() -> IoTSiteWiseClient:
    return Session().client("iotsitewise")

Paginators#

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

# DescribePipelineExecutionPaginator usage example

from boto3.session import Session

from mypy_boto3_iotsitewise.paginator import DescribePipelineExecutionPaginator

def get_describe_pipeline_execution_paginator() -> DescribePipelineExecutionPaginator:
    return Session().client("iotsitewise").get_paginator("describe_pipeline_execution"))

Waiters#

Type annotations and code completion for waiters from boto3.client("iotsitewise").get_waiter("...").

# AssetActiveWaiter usage example

from boto3.session import Session

from mypy_boto3_iotsitewise.waiter import AssetActiveWaiter

def get_asset_active_waiter() -> AssetActiveWaiter:
    return Session().client("iotsitewise").get_waiter("asset_active")

Literals#

Type annotations for literals used in methods and schema.

# AggregateTypeType usage example

from mypy_boto3_iotsitewise.literals import AggregateTypeType

def get_value() -> AggregateTypeType:
    return "AVERAGE"

Type definitions#

Type annotations for type definitions used in methods and schema.