IoTSiteWise module#
Index > IoTSiteWise
Auto-generated documentation for IoTSiteWise type annotations stubs module types-boto3-iotsitewise.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
IoTSiteWise
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and IoTSiteWise
.
From PyPI with pip#
Install types-boto3
for IoTSiteWise
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[iotsitewise]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[iotsitewise]'
# standalone installation
python -m pip install types-boto3-iotsitewise
How to uninstall#
python -m pip uninstall -y types-boto3-iotsitewise
Usage#
Code samples can be found in Examples.
IoTSiteWiseClient#
Type annotations and code completion for boto3.client("iotsitewise")
as IoTSiteWiseClient
boto3 documentation
# IoTSiteWiseClient usage example
from boto3.session import Session
from types_boto3_iotsitewise.client import IoTSiteWiseClient
def get_client() -> IoTSiteWiseClient:
return Session().client("iotsitewise")
Paginators#
Type annotations and code completion for paginators
from boto3.client("iotsitewise").get_paginator("...")
.
# ExecuteQueryPaginator usage example
from boto3.session import Session
from types_boto3_iotsitewise.paginator import ExecuteQueryPaginator
def get_execute_query_paginator() -> ExecuteQueryPaginator:
return Session().client("iotsitewise").get_paginator("execute_query"))
- ExecuteQueryPaginator
- GetAssetPropertyAggregatesPaginator
- GetAssetPropertyValueHistoryPaginator
- GetInterpolatedAssetPropertyValuesPaginator
- ListAccessPoliciesPaginator
- ListActionsPaginator
- ListAssetModelCompositeModelsPaginator
- ListAssetModelPropertiesPaginator
- ListAssetModelsPaginator
- ListAssetPropertiesPaginator
- ListAssetRelationshipsPaginator
- ListAssetsPaginator
- ListAssociatedAssetsPaginator
- ListBulkImportJobsPaginator
- ListCompositionRelationshipsPaginator
- ListDashboardsPaginator
- ListDatasetsPaginator
- ListGatewaysPaginator
- ListPortalsPaginator
- ListProjectAssetsPaginator
- ListProjectsPaginator
- ListTimeSeriesPaginator
Waiters#
Type annotations and code completion for waiters
from boto3.client("iotsitewise").get_waiter("...")
.
# AssetActiveWaiter usage example
from boto3.session import Session
from types_boto3_iotsitewise.waiter import AssetActiveWaiter
def get_asset_active_waiter() -> AssetActiveWaiter:
return Session().client("iotsitewise").get_waiter("asset_active")
- AssetActiveWaiter
- AssetModelActiveWaiter
- AssetModelNotExistsWaiter
- AssetNotExistsWaiter
- PortalActiveWaiter
- PortalNotExistsWaiter
Literals#
Type annotations for literals used in methods and schema.
# AggregateTypeType usage example
from types_boto3_iotsitewise.literals import AggregateTypeType
def get_value() -> AggregateTypeType:
return "AVERAGE"
- AggregateTypeType
- AssetActiveWaiterName
- AssetErrorCodeType
- AssetModelActiveWaiterName
- AssetModelNotExistsWaiterName
- AssetModelStateType
- AssetModelTypeType
- AssetModelVersionTypeType
- AssetNotExistsWaiterName
- AssetRelationshipTypeType
- AssetStateType
- AuthModeType
- BatchEntryCompletionStatusType
- BatchGetAssetPropertyAggregatesErrorCodeType
- BatchGetAssetPropertyValueErrorCodeType
- BatchGetAssetPropertyValueHistoryErrorCodeType
- BatchPutAssetPropertyValueErrorCodeType
- CapabilitySyncStatusType
- ColumnNameType
- ComputeLocationType
- ConfigurationStateType
- DatasetSourceFormatType
- DatasetSourceTypeType
- DatasetStateType
- DetailedErrorCodeType
- DisassociatedDataStorageStateType
- EncryptionTypeType
- ErrorCodeType
- ExecuteQueryPaginatorName
- ForwardingConfigStateType
- GetAssetPropertyAggregatesPaginatorName
- GetAssetPropertyValueHistoryPaginatorName
- GetInterpolatedAssetPropertyValuesPaginatorName
- IdentityTypeType
- ImageFileTypeType
- JobStatusType
- ListAccessPoliciesPaginatorName
- ListActionsPaginatorName
- ListAssetModelCompositeModelsPaginatorName
- ListAssetModelPropertiesFilterType
- ListAssetModelPropertiesPaginatorName
- ListAssetModelsPaginatorName
- ListAssetPropertiesFilterType
- ListAssetPropertiesPaginatorName
- ListAssetRelationshipsPaginatorName
- ListAssetsFilterType
- ListAssetsPaginatorName
- ListAssociatedAssetsPaginatorName
- ListBulkImportJobsFilterType
- ListBulkImportJobsPaginatorName
- ListCompositionRelationshipsPaginatorName
- ListDashboardsPaginatorName
- ListDatasetsPaginatorName
- ListGatewaysPaginatorName
- ListPortalsPaginatorName
- ListProjectAssetsPaginatorName
- ListProjectsPaginatorName
- ListTimeSeriesPaginatorName
- ListTimeSeriesTypeType
- LoggingLevelType
- MonitorErrorCodeType
- PermissionType
- PortalActiveWaiterName
- PortalNotExistsWaiterName
- PortalStateType
- PortalTypeType
- PropertyDataTypeType
- PropertyNotificationStateType
- QualityType
- RawValueTypeType
- ResourceTypeType
- ScalarTypeType
- StorageTypeType
- TargetResourceTypeType
- TimeOrderingType
- TraversalDirectionType
- TraversalTypeType
- WarmTierStateType
- IoTSiteWiseServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AccessDeniedExceptionTypeDef
- ActionDefinitionTypeDef
- ActionPayloadTypeDef
- TargetResourceTypeDef
- AggregatesTypeDef
- AlarmsTypeDef
- AssetCompositeModelPathSegmentTypeDef
- AssetErrorDetailsTypeDef
- AssetHierarchyInfoTypeDef
- AssetHierarchyTypeDef
- AssetModelCompositeModelPathSegmentTypeDef
- AssetModelHierarchyDefinitionTypeDef
- AssetModelHierarchyTypeDef
- AssetModelPropertyPathSegmentTypeDef
- AssetPropertyPathSegmentTypeDef
- PropertyNotificationTypeDef
- TimeInNanosTypeDef
- AssociateAssetsRequestTypeDef
- AssociateTimeSeriesToAssetPropertyRequestTypeDef
- AttributeTypeDef
- BatchAssociateProjectAssetsRequestTypeDef
- ResponseMetadataTypeDef
- BatchDisassociateProjectAssetsRequestTypeDef
- TimestampTypeDef
- BatchGetAssetPropertyAggregatesErrorEntryTypeDef
- BatchGetAssetPropertyAggregatesErrorInfoTypeDef
- BatchGetAssetPropertyValueEntryTypeDef
- BatchGetAssetPropertyValueErrorEntryTypeDef
- BatchGetAssetPropertyValueErrorInfoTypeDef
- BatchGetAssetPropertyValueHistoryErrorEntryTypeDef
- BatchGetAssetPropertyValueHistoryErrorInfoTypeDef
- BlobTypeDef
- ContentTypeDef
- ColumnTypeTypeDef
- CompositionRelationshipItemTypeDef
- CompositionRelationshipSummaryTypeDef
- ConfigurationErrorDetailsTypeDef
- ConflictingOperationExceptionTypeDef
- CreateAssetRequestTypeDef
- ErrorReportLocationTypeDef
- FileTypeDef
- CreateDashboardRequestTypeDef
- CreateProjectRequestTypeDef
- CsvOutputTypeDef
- CsvTypeDef
- CustomerManagedS3StorageTypeDef
- DashboardSummaryTypeDef
- DatumPaginatorTypeDef
- DatumTypeDef
- DatumWaiterTypeDef
- DeleteAccessPolicyRequestTypeDef
- DeleteAssetModelCompositeModelRequestTypeDef
- DeleteAssetModelRequestTypeDef
- DeleteAssetRequestTypeDef
- DeleteDashboardRequestTypeDef
- DeleteDatasetRequestTypeDef
- DeleteGatewayRequestTypeDef
- DeletePortalRequestTypeDef
- DeleteProjectRequestTypeDef
- DeleteTimeSeriesRequestTypeDef
- DescribeAccessPolicyRequestTypeDef
- DescribeActionRequestTypeDef
- DescribeAssetCompositeModelRequestTypeDef
- DescribeAssetModelCompositeModelRequestTypeDef
- DescribeAssetModelRequestTypeDef
- WaiterConfigTypeDef
- DescribeAssetPropertyRequestTypeDef
- DescribeAssetRequestTypeDef
- DescribeBulkImportJobRequestTypeDef
- DescribeDashboardRequestTypeDef
- DescribeDatasetRequestTypeDef
- DescribeGatewayCapabilityConfigurationRequestTypeDef
- DescribeGatewayRequestTypeDef
- GatewayCapabilitySummaryTypeDef
- LoggingOptionsTypeDef
- DescribePortalRequestTypeDef
- ImageLocationTypeDef
- PortalTypeEntryOutputTypeDef
- DescribeProjectRequestTypeDef
- RetentionPeriodTypeDef
- WarmTierRetentionPeriodTypeDef
- DescribeTimeSeriesRequestTypeDef
- DetailedErrorTypeDef
- DisassociateAssetsRequestTypeDef
- DisassociateTimeSeriesFromAssetPropertyRequestTypeDef
- PaginatorConfigTypeDef
- ExecuteQueryRequestTypeDef
- ForwardingConfigTypeDef
- GreengrassTypeDef
- GreengrassV2TypeDef
- SiemensIETypeDef
- GetAssetPropertyValueRequestTypeDef
- GetInterpolatedAssetPropertyValuesRequestTypeDef
- GroupIdentityTypeDef
- IAMRoleIdentityTypeDef
- IAMUserIdentityTypeDef
- UserIdentityTypeDef
- InternalFailureExceptionTypeDef
- InvalidRequestExceptionTypeDef
- InvokeAssistantRequestTypeDef
- JobSummaryTypeDef
- KendraSourceDetailTypeDef
- LimitExceededExceptionTypeDef
- ListAccessPoliciesRequestTypeDef
- ListActionsRequestTypeDef
- ListAssetModelCompositeModelsRequestTypeDef
- ListAssetModelPropertiesRequestTypeDef
- ListAssetModelsRequestTypeDef
- ListAssetPropertiesRequestTypeDef
- ListAssetRelationshipsRequestTypeDef
- ListAssetsRequestTypeDef
- ListAssociatedAssetsRequestTypeDef
- ListBulkImportJobsRequestTypeDef
- ListCompositionRelationshipsRequestTypeDef
- ListDashboardsRequestTypeDef
- ListDatasetsRequestTypeDef
- ListGatewaysRequestTypeDef
- ListPortalsRequestTypeDef
- ListProjectAssetsRequestTypeDef
- ListProjectsRequestTypeDef
- ProjectSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- ListTimeSeriesRequestTypeDef
- TimeSeriesSummaryTypeDef
- LocationTypeDef
- MetricProcessingConfigTypeDef
- TumblingWindowTypeDef
- MonitorErrorDetailsTypeDef
- PortalResourceTypeDef
- PortalTypeEntryTypeDef
- ProjectResourceTypeDef
- PropertyValueNullValueTypeDef
- PutDefaultEncryptionConfigurationRequestTypeDef
- ResourceNotFoundExceptionTypeDef
- ThrottlingExceptionTypeDef
- TraceTypeDef
- TagResourceRequestTypeDef
- UntagResourceRequestTypeDef
- UpdateAssetPropertyRequestTypeDef
- UpdateAssetRequestTypeDef
- UpdateDashboardRequestTypeDef
- UpdateGatewayCapabilityConfigurationRequestTypeDef
- UpdateGatewayRequestTypeDef
- UpdateProjectRequestTypeDef
- ActionSummaryTypeDef
- ExecuteActionRequestTypeDef
- AggregatedValueTypeDef
- AssetCompositeModelSummaryTypeDef
- AssetRelationshipSummaryTypeDef
- AssetModelCompositeModelSummaryTypeDef
- VariableValueOutputTypeDef
- VariableValueTypeDef
- AssetPropertySummaryTypeDef
- AssetPropertyTypeDef
- BatchPutAssetPropertyErrorTypeDef
- BatchAssociateProjectAssetsResponseTypeDef
- BatchDisassociateProjectAssetsResponseTypeDef
- CreateAccessPolicyResponseTypeDef
- CreateBulkImportJobResponseTypeDef
- CreateDashboardResponseTypeDef
- CreateGatewayResponseTypeDef
- CreateProjectResponseTypeDef
- DescribeActionResponseTypeDef
- DescribeDashboardResponseTypeDef
- DescribeGatewayCapabilityConfigurationResponseTypeDef
- DescribeProjectResponseTypeDef
- DescribeTimeSeriesResponseTypeDef
- EmptyResponseMetadataTypeDef
- ExecuteActionResponseTypeDef
- ListProjectAssetsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- UpdateGatewayCapabilityConfigurationResponseTypeDef
- BatchGetAssetPropertyAggregatesEntryTypeDef
- BatchGetAssetPropertyValueHistoryEntryTypeDef
- GetAssetPropertyAggregatesRequestTypeDef
- GetAssetPropertyValueHistoryRequestTypeDef
- BatchGetAssetPropertyAggregatesSkippedEntryTypeDef
- BatchGetAssetPropertyValueRequestTypeDef
- BatchGetAssetPropertyValueSkippedEntryTypeDef
- BatchGetAssetPropertyValueHistorySkippedEntryTypeDef
- ImageFileTypeDef
- ColumnInfoTypeDef
- CompositionDetailsTypeDef
- ListCompositionRelationshipsResponseTypeDef
- ConfigurationStatusTypeDef
- FileFormatOutputTypeDef
- FileFormatTypeDef
- MultiLayerStorageTypeDef
- ListDashboardsResponseTypeDef
- RowPaginatorTypeDef
- RowTypeDef
- RowWaiterTypeDef
- DescribeAssetModelRequestWaitExtraTypeDef
- DescribeAssetModelRequestWaitTypeDef
- DescribeAssetRequestWaitExtraTypeDef
- DescribeAssetRequestWaitTypeDef
- DescribePortalRequestWaitExtraTypeDef
- DescribePortalRequestWaitTypeDef
- DescribeLoggingOptionsResponseTypeDef
- PutLoggingOptionsRequestTypeDef
- ErrorDetailsTypeDef
- ExecuteQueryRequestPaginateTypeDef
- GetAssetPropertyAggregatesRequestPaginateTypeDef
- GetAssetPropertyValueHistoryRequestPaginateTypeDef
- GetInterpolatedAssetPropertyValuesRequestPaginateTypeDef
- ListAccessPoliciesRequestPaginateTypeDef
- ListActionsRequestPaginateTypeDef
- ListAssetModelCompositeModelsRequestPaginateTypeDef
- ListAssetModelPropertiesRequestPaginateTypeDef
- ListAssetModelsRequestPaginateTypeDef
- ListAssetPropertiesRequestPaginateTypeDef
- ListAssetRelationshipsRequestPaginateTypeDef
- ListAssetsRequestPaginateTypeDef
- ListAssociatedAssetsRequestPaginateTypeDef
- ListBulkImportJobsRequestPaginateTypeDef
- ListCompositionRelationshipsRequestPaginateTypeDef
- ListDashboardsRequestPaginateTypeDef
- ListDatasetsRequestPaginateTypeDef
- ListGatewaysRequestPaginateTypeDef
- ListPortalsRequestPaginateTypeDef
- ListProjectAssetsRequestPaginateTypeDef
- ListProjectsRequestPaginateTypeDef
- ListTimeSeriesRequestPaginateTypeDef
- MeasurementProcessingConfigTypeDef
- TransformProcessingConfigTypeDef
- GatewayPlatformTypeDef
- IdentityTypeDef
- ListBulkImportJobsResponseTypeDef
- SourceDetailTypeDef
- ListProjectsResponseTypeDef
- ListTimeSeriesResponseTypeDef
- SourceTypeDef
- MetricWindowTypeDef
- PortalStatusTypeDef
- PortalTypeEntryUnionTypeDef
- ResourceTypeDef
- VariantTypeDef
- ListActionsResponseTypeDef
- BatchGetAssetPropertyAggregatesSuccessEntryTypeDef
- GetAssetPropertyAggregatesResponseTypeDef
- ListAssetRelationshipsResponseTypeDef
- ListAssetModelCompositeModelsResponseTypeDef
- ExpressionVariableOutputTypeDef
- VariableValueUnionTypeDef
- ListAssetPropertiesResponseTypeDef
- AssetCompositeModelTypeDef
- DescribeAssetCompositeModelResponseTypeDef
- BatchPutAssetPropertyErrorEntryTypeDef
- BatchGetAssetPropertyAggregatesRequestTypeDef
- BatchGetAssetPropertyValueHistoryRequestTypeDef
- ImageTypeDef
- DescribeDefaultEncryptionConfigurationResponseTypeDef
- PutDefaultEncryptionConfigurationResponseTypeDef
- JobConfigurationOutputTypeDef
- JobConfigurationTypeDef
- DescribeStorageConfigurationResponseTypeDef
- PutStorageConfigurationRequestTypeDef
- PutStorageConfigurationResponseTypeDef
- ExecuteQueryResponsePaginatorTypeDef
- ExecuteQueryResponseTypeDef
- ExecuteQueryResponseWaiterTypeDef
- AssetModelStatusTypeDef
- AssetStatusTypeDef
- DatasetStatusTypeDef
- MeasurementTypeDef
- CreateGatewayRequestTypeDef
- DescribeGatewayResponseTypeDef
- GatewaySummaryTypeDef
- DatasetSourceTypeDef
- DataSetReferenceTypeDef
- CreatePortalResponseTypeDef
- DeletePortalResponseTypeDef
- DescribePortalResponseTypeDef
- PortalSummaryTypeDef
- UpdatePortalResponseTypeDef
- CreatePortalRequestTypeDef
- AccessPolicySummaryTypeDef
- CreateAccessPolicyRequestTypeDef
- DescribeAccessPolicyResponseTypeDef
- UpdateAccessPolicyRequestTypeDef
- AssetPropertyValueTypeDef
- InterpolatedAssetPropertyValueTypeDef
- BatchGetAssetPropertyAggregatesResponseTypeDef
- MetricOutputTypeDef
- TransformOutputTypeDef
- ExpressionVariableTypeDef
- BatchPutAssetPropertyValueResponseTypeDef
- UpdatePortalRequestTypeDef
- DescribeBulkImportJobResponseTypeDef
- JobConfigurationUnionTypeDef
- AssetModelSummaryTypeDef
- CreateAssetModelCompositeModelResponseTypeDef
- CreateAssetModelResponseTypeDef
- DeleteAssetModelCompositeModelResponseTypeDef
- DeleteAssetModelResponseTypeDef
- UpdateAssetModelCompositeModelResponseTypeDef
- UpdateAssetModelResponseTypeDef
- AssetSummaryTypeDef
- AssociatedAssetsSummaryTypeDef
- CreateAssetResponseTypeDef
- DeleteAssetResponseTypeDef
- DescribeAssetResponseTypeDef
- UpdateAssetResponseTypeDef
- CreateDatasetResponseTypeDef
- DatasetSummaryTypeDef
- DeleteDatasetResponseTypeDef
- UpdateDatasetResponseTypeDef
- ListGatewaysResponseTypeDef
- CreateDatasetRequestTypeDef
- DescribeDatasetResponseTypeDef
- UpdateDatasetRequestTypeDef
- ReferenceTypeDef
- ListPortalsResponseTypeDef
- ListAccessPoliciesResponseTypeDef
- BatchGetAssetPropertyValueHistorySuccessEntryTypeDef
- BatchGetAssetPropertyValueSuccessEntryTypeDef
- GetAssetPropertyValueHistoryResponseTypeDef
- GetAssetPropertyValueResponseTypeDef
- PutAssetPropertyValueEntryTypeDef
- GetInterpolatedAssetPropertyValuesResponseTypeDef
- PropertyTypeOutputTypeDef
- ExpressionVariableUnionTypeDef
- CreateBulkImportJobRequestTypeDef
- ListAssetModelsResponseTypeDef
- ListAssetsResponseTypeDef
- ListAssociatedAssetsResponseTypeDef
- ListDatasetsResponseTypeDef
- CitationTypeDef
- BatchGetAssetPropertyValueHistoryResponseTypeDef
- BatchGetAssetPropertyValueResponseTypeDef
- BatchPutAssetPropertyValueRequestTypeDef
- AssetModelPropertyOutputTypeDef
- AssetModelPropertySummaryTypeDef
- PropertyTypeDef
- MetricTypeDef
- TransformTypeDef
- InvocationOutputTypeDef
- AssetModelCompositeModelOutputTypeDef
- DescribeAssetModelCompositeModelResponseTypeDef
- ListAssetModelPropertiesResponseTypeDef
- CompositeModelPropertyTypeDef
- MetricUnionTypeDef
- TransformUnionTypeDef
- ResponseStreamTypeDef
- DescribeAssetModelResponseTypeDef
- DescribeAssetPropertyResponseTypeDef
- PropertyTypeTypeDef
- InvokeAssistantResponseTypeDef
- PropertyTypeUnionTypeDef
- AssetModelPropertyDefinitionTypeDef
- AssetModelPropertyTypeDef
- AssetModelCompositeModelDefinitionTypeDef
- CreateAssetModelCompositeModelRequestTypeDef
- AssetModelPropertyUnionTypeDef
- CreateAssetModelRequestTypeDef
- AssetModelCompositeModelTypeDef
- UpdateAssetModelCompositeModelRequestTypeDef
- AssetModelCompositeModelUnionTypeDef
- UpdateAssetModelRequestTypeDef