IoTSiteWiseClient

Index > IoTSiteWise > IoTSiteWiseClient

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

IoTSiteWiseClient

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

# IoTSiteWiseClient usage example

from boto3.session import Session
from mypy_boto3_iotsitewise.client import IoTSiteWiseClient

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

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("iotsitewise").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("iotsitewise")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictingOperationException,
    client.exceptions.InternalFailureException,
    client.exceptions.InvalidRequestException,
    client.exceptions.LimitExceededException,
    client.exceptions.PreconditionFailedException,
    client.exceptions.QueryTimeoutException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.ThrottlingException,
    client.exceptions.TooManyTagsException,
    client.exceptions.UnauthorizedException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_iotsitewise.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

associate_assets

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.

Type annotations and code completion for boto3.client("iotsitewise").associate_assets method. boto3 documentation

# associate_assets method definition

def associate_assets(
    self,
    *,
    assetId: str,
    hierarchyId: str,
    childAssetId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# associate_assets method usage example with argument unpacking

kwargs: AssociateAssetsRequestRequestTypeDef = {  # (1)
    "assetId": ...,
    "hierarchyId": ...,
    "childAssetId": ...,
}

parent.associate_assets(**kwargs)

1. See AssociateAssetsRequestRequestTypeDef

associate_time_series_to_asset_property

Associates a time series (data stream) with an asset property.

Type annotations and code completion for boto3.client("iotsitewise").associate_time_series_to_asset_property method.