Skip to content

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.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. boto3 documentation

# associate_time_series_to_asset_property method definition

def associate_time_series_to_asset_property(
    self,
    *,
    alias: str,
    assetId: str,
    propertyId: str,
    clientToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# associate_time_series_to_asset_property method usage example with argument unpacking

kwargs: AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef = {  # (1)
    "alias": ...,
    "assetId": ...,
    "propertyId": ...,
}

parent.associate_time_series_to_asset_property(**kwargs)
  1. See AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef

batch_associate_project_assets#

Associates a group (batch) of assets with an IoT SiteWise Monitor project.

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

# batch_associate_project_assets method definition

def batch_associate_project_assets(
    self,
    *,
    projectId: str,
    assetIds: Sequence[str],
    clientToken: str = ...,
) -> BatchAssociateProjectAssetsResponseTypeDef:  # (1)
    ...
  1. See BatchAssociateProjectAssetsResponseTypeDef
# batch_associate_project_assets method usage example with argument unpacking

kwargs: BatchAssociateProjectAssetsRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "assetIds": ...,
}

parent.batch_associate_project_assets(**kwargs)
  1. See BatchAssociateProjectAssetsRequestRequestTypeDef

batch_disassociate_project_assets#

Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.

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

# batch_disassociate_project_assets method definition

def batch_disassociate_project_assets(
    self,
    *,
    projectId: str,
    assetIds: Sequence[str],
    clientToken: str = ...,
) -> BatchDisassociateProjectAssetsResponseTypeDef:  # (1)
    ...
  1. See BatchDisassociateProjectAssetsResponseTypeDef
# batch_disassociate_project_assets method usage example with argument unpacking

kwargs: BatchDisassociateProjectAssetsRequestRequestTypeDef = {  # (1)
    "projectId": ...,
    "assetIds": ...,
}

parent.batch_disassociate_project_assets(**kwargs)
  1. See BatchDisassociateProjectAssetsRequestRequestTypeDef

batch_get_asset_property_aggregates#

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.

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

# batch_get_asset_property_aggregates method definition

def batch_get_asset_property_aggregates(
    self,
    *,
    entries: Sequence[BatchGetAssetPropertyAggregatesEntryTypeDef],  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> BatchGetAssetPropertyAggregatesResponseTypeDef:  # (2)
    ...
  1. See BatchGetAssetPropertyAggregatesEntryTypeDef
  2. See BatchGetAssetPropertyAggregatesResponseTypeDef
# batch_get_asset_property_aggregates method usage example with argument unpacking

kwargs: BatchGetAssetPropertyAggregatesRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_get_asset_property_aggregates(**kwargs)
  1. See BatchGetAssetPropertyAggregatesRequestRequestTypeDef

batch_get_asset_property_value#

Gets the current value for one or more asset properties.

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

# batch_get_asset_property_value method definition

def batch_get_asset_property_value(
    self,
    *,
    entries: Sequence[BatchGetAssetPropertyValueEntryTypeDef],  # (1)
    nextToken: str = ...,
) -> BatchGetAssetPropertyValueResponseTypeDef:  # (2)
    ...
  1. See BatchGetAssetPropertyValueEntryTypeDef
  2. See BatchGetAssetPropertyValueResponseTypeDef
# batch_get_asset_property_value method usage example with argument unpacking

kwargs: BatchGetAssetPropertyValueRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_get_asset_property_value(**kwargs)
  1. See BatchGetAssetPropertyValueRequestRequestTypeDef

batch_get_asset_property_value_history#

Gets the historical values for one or more asset properties.

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

# batch_get_asset_property_value_history method definition

def batch_get_asset_property_value_history(
    self,
    *,
    entries: Sequence[BatchGetAssetPropertyValueHistoryEntryTypeDef],  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> BatchGetAssetPropertyValueHistoryResponseTypeDef:  # (2)
    ...
  1. See BatchGetAssetPropertyValueHistoryEntryTypeDef
  2. See BatchGetAssetPropertyValueHistoryResponseTypeDef
# batch_get_asset_property_value_history method usage example with argument unpacking

kwargs: BatchGetAssetPropertyValueHistoryRequestRequestTypeDef = {  # (1)
    "entries": ...,
}

parent.batch_get_asset_property_value_history(**kwargs)
  1. See BatchGetAssetPropertyValueHistoryRequestRequestTypeDef

batch_put_asset_property_value#

Sends a list of asset property values to IoT SiteWise.

Typ