IoTSiteWise module#
Index > IoTSiteWise
Auto-generated documentation for IoTSiteWise type annotations stubs module mypy-boto3-iotsitewise.
How to install#
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 boto3-stubs
for IoTSiteWise
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[iotsitewise]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[iotsitewise]'
# standalone installation
python -m pip install mypy-boto3-iotsitewise
How to uninstall#
python -m pip uninstall -y mypy-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 mypy_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("...")
.
# GetAssetPropertyAggregatesPaginator usage example
from boto3.session import Session
from mypy_boto3_iotsitewise.paginator import GetAssetPropertyAggregatesPaginator
def get_get_asset_property_aggregates_paginator() -> GetAssetPropertyAggregatesPaginator:
return Session().client("iotsitewise").get_paginator("get_asset_property_aggregates"))
- GetAssetPropertyAggregatesPaginator
- GetAssetPropertyValueHistoryPaginator
- GetInterpolatedAssetPropertyValuesPaginator
- ListAccessPoliciesPaginator
- ListAssetModelPropertiesPaginator
- ListAssetModelsPaginator
- ListAssetPropertiesPaginator
- ListAssetRelationshipsPaginator
- ListAssetsPaginator
- ListAssociatedAssetsPaginator
- ListBulkImportJobsPaginator
- ListDashboardsPaginator
- 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 mypy_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 schemas.
# AggregateTypeType usage example
from mypy_boto3_iotsitewise.literals import AggregateTypeType
def get_value() -> AggregateTypeType:
return "AVERAGE"
- AggregateTypeType
- AssetActiveWaiterName
- AssetErrorCodeType
- AssetModelActiveWaiterName
- AssetModelNotExistsWaiterName
- AssetModelStateType
- AssetNotExistsWaiterName
- AssetRelationshipTypeType
- AssetStateType
- AuthModeType
- BatchEntryCompletionStatusType
- BatchGetAssetPropertyAggregatesErrorCodeType
- BatchGetAssetPropertyValueErrorCodeType
- BatchGetAssetPropertyValueHistoryErrorCodeType
- BatchPutAssetPropertyValueErrorCodeType
- CapabilitySyncStatusType
- ColumnNameType
- ComputeLocationType
- ConfigurationStateType
- DetailedErrorCodeType
- DisassociatedDataStorageStateType
- EncryptionTypeType
- ErrorCodeType
- ForwardingConfigStateType
- GetAssetPropertyAggregatesPaginatorName
- GetAssetPropertyValueHistoryPaginatorName
- GetInterpolatedAssetPropertyValuesPaginatorName
- IdentityTypeType
- ImageFileTypeType
- JobStatusType
- ListAccessPoliciesPaginatorName
- ListAssetModelPropertiesFilterType
- ListAssetModelPropertiesPaginatorName
- ListAssetModelsPaginatorName
- ListAssetPropertiesFilterType
- ListAssetPropertiesPaginatorName
- ListAssetRelationshipsPaginatorName
- ListAssetsFilterType
- ListAssetsPaginatorName
- ListAssociatedAssetsPaginatorName
- ListBulkImportJobsFilterType
- ListBulkImportJobsPaginatorName
- ListDashboardsPaginatorName
- ListGatewaysPaginatorName
- ListPortalsPaginatorName
- ListProjectAssetsPaginatorName
- ListProjectsPaginatorName
- ListTimeSeriesPaginatorName
- ListTimeSeriesTypeType
- LoggingLevelType
- MonitorErrorCodeType
- PermissionType
- PortalActiveWaiterName
- PortalNotExistsWaiterName
- PortalStateType
- PropertyDataTypeType
- PropertyNotificationStateType
- QualityType
- ResourceTypeType
- StorageTypeType
- TimeOrderingType
- TraversalDirectionType
- TraversalTypeType
- IoTSiteWiseServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AggregatesTypeDef usage example
from mypy_boto3_iotsitewise.type_defs import AggregatesTypeDef
def get_value() -> AggregatesTypeDef:
return {
"average": ...,
}
- AggregatesTypeDef
- AlarmsTypeDef
- AssetErrorDetailsTypeDef
- AssetHierarchyInfoTypeDef
- AssetHierarchyTypeDef
- AssetModelHierarchyDefinitionTypeDef
- AssetModelHierarchyTypeDef
- PropertyNotificationTypeDef
- TimeInNanosTypeDef
- VariantTypeDef
- AssociateAssetsRequestRequestTypeDef
- AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef
- AttributeTypeDef
- BatchAssociateProjectAssetsRequestRequestTypeDef
- BatchDisassociateProjectAssetsRequestRequestTypeDef
- BatchGetAssetPropertyAggregatesEntryTypeDef
- BatchGetAssetPropertyAggregatesErrorEntryTypeDef
- BatchGetAssetPropertyAggregatesErrorInfoTypeDef
- BatchGetAssetPropertyValueEntryTypeDef
- BatchGetAssetPropertyValueErrorEntryTypeDef
- BatchGetAssetPropertyValueErrorInfoTypeDef
- BatchGetAssetPropertyValueHistoryEntryTypeDef
- BatchGetAssetPropertyValueHistoryErrorEntryTypeDef
- BatchGetAssetPropertyValueHistoryErrorInfoTypeDef
- ConfigurationErrorDetailsTypeDef
- CreateAccessPolicyResponseTypeDef
- CreateAssetRequestRequestTypeDef
- ErrorReportLocationTypeDef
- FileTypeDef
- CreateBulkImportJobResponseTypeDef
- CreateDashboardRequestRequestTypeDef
- CreateDashboardResponseTypeDef
- CreateGatewayResponseTypeDef
- ImageFileTypeDef
- CreateProjectRequestRequestTypeDef
- CreateProjectResponseTypeDef
- CsvTypeDef
- CustomerManagedS3StorageTypeDef
- DashboardSummaryTypeDef
- DeleteAccessPolicyRequestRequestTypeDef
- DeleteAssetModelRequestRequestTypeDef
- DeleteAssetRequestRequestTypeDef
- DeleteDashboardRequestRequestTypeDef
- DeleteGatewayRequestRequestTypeDef
- DeletePortalRequestRequestTypeDef
- DeleteProjectRequestRequestTypeDef
- DeleteTimeSeriesRequestRequestTypeDef
- DescribeAccessPolicyRequestRequestTypeDef
- WaiterConfigTypeDef
- DescribeAssetModelRequestRequestTypeDef
- DescribeAssetPropertyRequestRequestTypeDef
- DescribeAssetRequestRequestTypeDef
- DescribeBulkImportJobRequestRequestTypeDef
- DescribeDashboardRequestRequestTypeDef
- DescribeDashboardResponseTypeDef
- DescribeGatewayCapabilityConfigurationRequestRequestTypeDef
- DescribeGatewayCapabilityConfigurationResponseTypeDef
- DescribeGatewayRequestRequestTypeDef
- GatewayCapabilitySummaryTypeDef
- LoggingOptionsTypeDef
- DescribePortalRequestRequestTypeDef
- ImageLocationTypeDef
- DescribeProjectRequestRequestTypeDef
- DescribeProjectResponseTypeDef
- RetentionPeriodTypeDef
- DescribeTimeSeriesRequestRequestTypeDef
- DescribeTimeSeriesResponseTypeDef
- DetailedErrorTypeDef
- DisassociateAssetsRequestRequestTypeDef
- DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef
- EmptyResponseMetadataTypeDef
- VariableValueTypeDef
- ForwardingConfigTypeDef
- GreengrassTypeDef
- GreengrassV2TypeDef
- GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef
- GetAssetPropertyAggregatesRequestRequestTypeDef
- GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef
- GetAssetPropertyValueHistoryRequestRequestTypeDef
- GetAssetPropertyValueRequestRequestTypeDef
- GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef
- GetInterpolatedAssetPropertyValuesRequestRequestTypeDef
- GroupIdentityTypeDef
- IAMRoleIdentityTypeDef
- IAMUserIdentityTypeDef
- UserIdentityTypeDef
- JobSummaryTypeDef
- ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef
- ListAccessPoliciesRequestRequestTypeDef
- ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef
- ListAssetModelPropertiesRequestRequestTypeDef
- ListAssetModelsRequestListAssetModelsPaginateTypeDef
- ListAssetModelsRequestRequestTypeDef
- ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef
- ListAssetPropertiesRequestRequestTypeDef
- ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef
- ListAssetRelationshipsRequestRequestTypeDef
- ListAssetsRequestListAssetsPaginateTypeDef
- ListAssetsRequestRequestTypeDef
- ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef
- ListAssociatedAssetsRequestRequestTypeDef
- ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef
- ListBulkImportJobsRequestRequestTypeDef
- ListDashboardsRequestListDashboardsPaginateTypeDef
- ListDashboardsRequestRequestTypeDef
- ListGatewaysRequestListGatewaysPaginateTypeDef
- ListGatewaysRequestRequestTypeDef
- ListPortalsRequestListPortalsPaginateTypeDef
- ListPortalsRequestRequestTypeDef
- ListProjectAssetsRequestListProjectAssetsPaginateTypeDef
- ListProjectAssetsRequestRequestTypeDef
- ListProjectAssetsResponseTypeDef
- ListProjectsRequestListProjectsPaginateTypeDef
- ListProjectsRequestRequestTypeDef
- ProjectSummaryTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTagsForResourceResponseTypeDef
- ListTimeSeriesRequestListTimeSeriesPaginateTypeDef
- ListTimeSeriesRequestRequestTypeDef
- TimeSeriesSummaryTypeDef
- MetricProcessingConfigTypeDef
- TumblingWindowTypeDef
- MonitorErrorDetailsTypeDef
- PaginatorConfigTypeDef
- PortalResourceTypeDef
- ProjectResourceTypeDef
- PutDefaultEncryptionConfigurationRequestRequestTypeDef
- ResponseMetadataTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- UpdateAssetPropertyRequestRequestTypeDef
- UpdateAssetRequestRequestTypeDef
- UpdateDashboardRequestRequestTypeDef
- UpdateGatewayCapabilityConfigurationRequestRequestTypeDef
- UpdateGatewayCapabilityConfigurationResponseTypeDef
- UpdateGatewayRequestRequestTypeDef
- UpdateProjectRequestRequestTypeDef
- AggregatedValueTypeDef
- BatchAssociateProjectAssetsResponseTypeDef
- BatchDisassociateProjectAssetsResponseTypeDef
- AssetRelationshipSummaryTypeDef
- AssetPropertySummaryTypeDef
- AssetPropertyTypeDef
- BatchPutAssetPropertyErrorTypeDef
- AssetPropertyValueTypeDef
- InterpolatedAssetPropertyValueTypeDef
- BatchGetAssetPropertyAggregatesRequestRequestTypeDef
- BatchGetAssetPropertyAggregatesSkippedEntryTypeDef
- BatchGetAssetPropertyValueRequestRequestTypeDef
- BatchGetAssetPropertyValueSkippedEntryTypeDef
- BatchGetAssetPropertyValueHistoryRequestRequestTypeDef
- BatchGetAssetPropertyValueHistorySkippedEntryTypeDef
- ConfigurationStatusTypeDef
- CreatePortalRequestRequestTypeDef
- ImageTypeDef
- FileFormatTypeDef
- MultiLayerStorageTypeDef
- ListDashboardsResponseTypeDef
- DescribeAssetModelRequestAssetModelActiveWaitTypeDef
- DescribeAssetModelRequestAssetModelNotExistsWaitTypeDef
- DescribeAssetRequestAssetActiveWaitTypeDef
- DescribeAssetRequestAssetNotExistsWaitTypeDef
- DescribePortalRequestPortalActiveWaitTypeDef
- DescribePortalRequestPortalNotExistsWaitTypeDef
- DescribeLoggingOptionsResponseTypeDef
- PutLoggingOptionsRequestRequestTypeDef
- ErrorDetailsTypeDef
- ExpressionVariableTypeDef
- MeasurementProcessingConfigTypeDef
- TransformProcessingConfigTypeDef
- GatewayPlatformTypeDef
- IdentityTypeDef
- ListBulkImportJobsResponseTypeDef
- ListProjectsResponseTypeDef
- ListTimeSeriesResponseTypeDef
- MetricWindowTypeDef
- PortalStatusTypeDef
- ResourceTypeDef
- BatchGetAssetPropertyAggregatesSuccessEntryTypeDef
- GetAssetPropertyAggregatesResponseTypeDef
- ListAssetRelationshipsResponseTypeDef
- ListAssetPropertiesResponseTypeDef
- AssetCompositeModelTypeDef
- BatchPutAssetPropertyErrorEntryTypeDef
- BatchGetAssetPropertyValueHistorySuccessEntryTypeDef
- BatchGetAssetPropertyValueSuccessEntryTypeDef
- GetAssetPropertyValueHistoryResponseTypeDef
- GetAssetPropertyValueResponseTypeDef
- PutAssetPropertyValueEntryTypeDef
- GetInterpolatedAssetPropertyValuesResponseTypeDef
- DescribeDefaultEncryptionConfigurationResponseTypeDef
- PutDefaultEncryptionConfigurationResponseTypeDef
- UpdatePortalRequestRequestTypeDef
- JobConfigurationTypeDef
- DescribeStorageConfigurationResponseTypeDef
- PutStorageConfigurationRequestRequestTypeDef
- PutStorageConfigurationResponseTypeDef
- AssetModelStatusTypeDef
- AssetStatusTypeDef
- MeasurementTypeDef
- TransformTypeDef
- CreateGatewayRequestRequestTypeDef
- DescribeGatewayResponseTypeDef
- GatewaySummaryTypeDef
- MetricTypeDef
- CreatePortalResponseTypeDef
- DeletePortalResponseTypeDef
- DescribePortalResponseTypeDef
- PortalSummaryTypeDef
- UpdatePortalResponseTypeDef
- AccessPolicySummaryTypeDef
- CreateAccessPolicyRequestRequestTypeDef
- DescribeAccessPolicyResponseTypeDef
- UpdateAccessPolicyRequestRequestTypeDef
- BatchGetAssetPropertyAggregatesResponseTypeDef
- BatchPutAssetPropertyValueResponseTypeDef
- BatchGetAssetPropertyValueHistoryResponseTypeDef
- BatchGetAssetPropertyValueResponseTypeDef
- BatchPutAssetPropertyValueRequestRequestTypeDef
- CreateBulkImportJobRequestRequestTypeDef
- DescribeBulkImportJobResponseTypeDef
- AssetModelSummaryTypeDef
- CreateAssetModelResponseTypeDef
- DeleteAssetModelResponseTypeDef
- UpdateAssetModelResponseTypeDef
- AssetSummaryTypeDef
- AssociatedAssetsSummaryTypeDef
- CreateAssetResponseTypeDef
- DeleteAssetResponseTypeDef
- DescribeAssetResponseTypeDef
- UpdateAssetResponseTypeDef
- ListGatewaysResponseTypeDef
- PropertyTypeTypeDef
- ListPortalsResponseTypeDef
- ListAccessPoliciesResponseTypeDef
- ListAssetModelsResponseTypeDef
- ListAssetsResponseTypeDef
- ListAssociatedAssetsResponseTypeDef
- AssetModelPropertyDefinitionTypeDef
- AssetModelPropertySummaryTypeDef
- AssetModelPropertyTypeDef
- PropertyTypeDef
- AssetModelCompositeModelDefinitionTypeDef
- ListAssetModelPropertiesResponseTypeDef
- AssetModelCompositeModelTypeDef
- CompositeModelPropertyTypeDef
- CreateAssetModelRequestRequestTypeDef
- DescribeAssetModelResponseTypeDef
- UpdateAssetModelRequestRequestTypeDef
- DescribeAssetPropertyResponseTypeDef