mypy-boto3-iotsitewise 1.13.25.0

Type annotations for boto3.IoTSiteWise 1.13.25 service, generated by mypy-boto3-buider 2.0.2

mypy-boto3-iotsitewise

• mypy-boto3-iotsitewise
  • How to use
  • Automated type discovery

Type annotations for boto3.IoTSiteWise 1.13.25 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 2.0.2.

More information can be found on boto3-stubs page.

• mypy-boto3-iotsitewise
  • How to use
    • Type checking
  • How it works

How to use

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for IoTSiteWise service.

python -m pip install boto3-stubs[iotsitewise]

# update installed packages index for automated type discovery
python -m mypy_boto3

Use boto3 with mypy_boto3_iotsitewise in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3_iotsitewise import IoTSiteWiseClient

# Now mypy can check if your code is valid.
client: IoTSiteWiseClient = boto3.client("iotsitewise")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: IoTSiteWiseClient = session.client("iotsitewise")



# Waiters are also supported

import mypy_boto3_iotsitewise.waiter as iotsitewise_waiters

asset_active_waiter: iotsitewise_waiters.AssetActiveWaiter = client.get_waiter("asset_active")
asset_model_active_waiter: iotsitewise_waiters.AssetModelActiveWaiter = client.get_waiter("asset_model_active")
asset_model_not_exists_waiter: iotsitewise_waiters.AssetModelNotExistsWaiter = client.get_waiter("asset_model_not_exists")
asset_not_exists_waiter: iotsitewise_waiters.AssetNotExistsWaiter = client.get_waiter("asset_not_exists")
portal_active_waiter: iotsitewise_waiters.PortalActiveWaiter = client.get_waiter("portal_active")
portal_not_exists_waiter: iotsitewise_waiters.PortalNotExistsWaiter = client.get_waiter("portal_not_exists")


# Annotated paginators are included as well

import mypy_boto3_iotsitewise.paginator as iotsitewise_paginators

get_asset_property_aggregates_paginator: iotsitewise_paginators.GetAssetPropertyAggregatesPaginator = client.get_paginator("get_asset_property_aggregates")
get_asset_property_value_history_paginator: iotsitewise_paginators.GetAssetPropertyValueHistoryPaginator = client.get_paginator("get_asset_property_value_history")
list_access_policies_paginator: iotsitewise_paginators.ListAccessPoliciesPaginator = client.get_paginator("list_access_policies")
list_asset_models_paginator: iotsitewise_paginators.ListAssetModelsPaginator = client.get_paginator("list_asset_models")
list_assets_paginator: iotsitewise_paginators.ListAssetsPaginator = client.get_paginator("list_assets")
list_associated_assets_paginator: iotsitewise_paginators.ListAssociatedAssetsPaginator = client.get_paginator("list_associated_assets")
list_dashboards_paginator: iotsitewise_paginators.ListDashboardsPaginator = client.get_paginator("list_dashboards")
list_gateways_paginator: iotsitewise_paginators.ListGatewaysPaginator = client.get_paginator("list_gateways")
list_portals_paginator: iotsitewise_paginators.ListPortalsPaginator = client.get_paginator("list_portals")
list_project_assets_paginator: iotsitewise_paginators.ListProjectAssetsPaginator = client.get_paginator("list_project_assets")
list_projects_paginator: iotsitewise_paginators.ListProjectsPaginator = client.get_paginator("list_projects")

Automated type discovery

mypy_boto3 package can generate index for mypy_boto3_iotsitewise and other installed services.

# Run this command when you add or remove service packages
python -m mypy_boto3

Generated index provides overloads for boto3.client and boto3.service, boto3.Session.client and boto3.Session.resource functions, so explicit type annotations are not needed.

• mypy supports function overloads as expected
• PyCharm also supports function overloads, but consumes a lot of RAM, use carefully
• VSCode does not currently support function overloads

Also, generated index allows you to import types from mypy_boto3:

# you can replace imports
import mypy_boto3_iotsitewise as iotsitewise
from mypy_boto3_iotsitewise import IoTSiteWiseClient

# with these
from mypy_boto3 import iotsitewise
from mypy_boto3.iotsitewise import IoTSiteWiseClient