Skip to content

Examples#

Index > IoTSiteWise > Examples

Auto-generated documentation for IoTSiteWise type annotations stubs module types-aiobotocore-iotsitewise.

Client#

Implicit type annotations#

Can be used with types-aioboto3[iotsitewise] package installed.

Write your IoTSiteWise code as usual, type checking and code completion should work out of the box.

# IoTSiteWiseClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("iotsitewise") as client:  # (1)
    result = await client.associate_assets()  # (2)
  1. client: IoTSiteWiseClient
  2. result: EmptyResponseMetadataTypeDef
# ExecuteQueryPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("iotsitewise") as client:  # (1)
    paginator = client.get_paginator("execute_query")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: IoTSiteWiseClient
  2. paginator: ExecuteQueryPaginator
  3. item: ExecuteQueryResponseTypeDef
# AssetActiveWaiter usage example

from aioboto3.session import Session


session = Session()

async with session.client("iotsitewise") as client:  # (1)
    waiter = client.get_waiter("asset_active")  # (2)
    await waiter.wait()
  1. client: IoTSiteWiseClient
  2. waiter: AssetActiveWaiter

Explicit type annotations#

With types-aioboto3-lite[iotsitewise] or a standalone types_aiobotocore_iotsitewise package, you have to explicitly specify client: IoTSiteWiseClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# IoTSiteWiseClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_iotsitewise.client import IoTSiteWiseClient
from types_aiobotocore_iotsitewise.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_iotsitewise.type_defs import AssociateAssetsRequestRequestTypeDef


session = Session()

client: IoTSiteWiseClient
async with session.client("iotsitewise") as client:  # (1)
    kwargs: AssociateAssetsRequestRequestTypeDef = {...}  # (2)
    result: EmptyResponseMetadataTypeDef = await client.associate_assets(**kwargs)  # (3)
  1. client: IoTSiteWiseClient
  2. kwargs: AssociateAssetsRequestRequestTypeDef
  3. result: EmptyResponseMetadataTypeDef
# ExecuteQueryPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_iotsitewise.client import IoTSiteWiseClient
from types_aiobotocore_iotsitewise.paginator import ExecuteQueryPaginator
from types_aiobotocore_iotsitewise.type_defs import ExecuteQueryResponseTypeDef


session = Session()

client: IoTSiteWiseClient
async with session.client("iotsitewise") as client:  # (1)
    paginator: ExecuteQueryPaginator = client.get_paginator("execute_query")  # (2)
    async for item in paginator.paginate(...):
        item: ExecuteQueryResponseTypeDef
        print(item)  # (3)
  1. client: IoTSiteWiseClient
  2. paginator: ExecuteQueryPaginator
  3. item: ExecuteQueryResponseTypeDef
# AssetActiveWaiter usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_iotsitewise.client import IoTSiteWiseClient
from types_aiobotocore_iotsitewise.waiter import AssetActiveWaiter


session = Session()

async with session.client("iotsitewise") as client:  # (1)
    waiter = client.get_waiter("asset_active")  # (2)
    await waiter.wait()
  1. client: IoTSiteWiseClient
  2. waiter: AssetActiveWaiter