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.

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

# batch_put_asset_property_value method definition

def batch_put_asset_property_value(
    self,
    *,
    entries: Sequence[PutAssetPropertyValueEntryTypeDef],  # (1)
) -> BatchPutAssetPropertyValueResponseTypeDef:  # (2)
    ...
  1. See PutAssetPropertyValueEntryTypeDef
  2. See BatchPutAssetPropertyValueResponseTypeDef 
# batch_put_asset_property_value method usage example with argument unpacking

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

parent.batch_put_asset_property_value(**kwargs)
  1. See BatchPutAssetPropertyValueRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

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

# close method definition

def close(
    self,
) -> None:
    ...

create_access_policy#

Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource.

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

# create_access_policy method definition

def create_access_policy(
    self,
    *,
    accessPolicyIdentity: IdentityTypeDef,  # (1)
    accessPolicyResource: ResourceTypeDef,  # (2)
    accessPolicyPermission: PermissionType,  # (3)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAccessPolicyResponseTypeDef:  # (4)
    ...
  1. See IdentityTypeDef
  2. See ResourceTypeDef
  3. See PermissionType
  4. See CreateAccessPolicyResponseTypeDef 
# create_access_policy method usage example with argument unpacking

kwargs: CreateAccessPolicyRequestRequestTypeDef = {  # (1)
    "accessPolicyIdentity": ...,
    "accessPolicyResource": ...,
    "accessPolicyPermission": ...,
}

parent.create_access_policy(**kwargs)
  1. See CreateAccessPolicyRequestRequestTypeDef

create_asset#

Creates an asset from an existing asset model.

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