Skip to content

IoTSiteWise module

Index > IoTSiteWise

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

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

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("...").

Usage example
from boto3.session import Session

from mypy_boto3_iotsitewise.paginator import GetAssetPropertyAggregatesPaginator

def get_get_asset_property_aggregates_paginator() -> GetAssetPropertyAggregatesPaginator:
    return Session().client("iotsitewise").get_paginator("get_asset_property_aggregates"))

Waiters

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

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

Usage example
from mypy_boto3_iotsitewise.literals import AggregateTypeType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_iotsitewise.type_defs import AggregatesTypeDef

def get_value() -> AggregatesTypeDef:
    return {
        "average": ...,
    }