diff options
Diffstat (limited to 'python-mypy-boto3-iotsitewise.spec')
| -rw-r--r-- | python-mypy-boto3-iotsitewise.spec | 2428 |
1 files changed, 2428 insertions, 0 deletions
diff --git a/python-mypy-boto3-iotsitewise.spec b/python-mypy-boto3-iotsitewise.spec new file mode 100644 index 0000000..338bebf --- /dev/null +++ b/python-mypy-boto3-iotsitewise.spec @@ -0,0 +1,2428 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-iotsitewise +Version: 1.26.96 +Release: 1 +Summary: Type annotations for boto3.IoTSiteWise 1.26.96 service generated with mypy-boto3-builder 7.13.0 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/75/50/d1708133a98eac1be10fd8632e4e2d2d4b995edf77709787c1bd0fd6baf8/mypy-boto3-iotsitewise-1.26.96.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description +<a id="mypy-boto3-iotsitewise"></a> + +# mypy-boto3-iotsitewise + +[](https://pypi.org/project/mypy-boto3-iotsitewise) +[](https://pypi.org/project/mypy-boto3-iotsitewise) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-iotsitewise) + + + +Type annotations for +[boto3.IoTSiteWise 1.26.96](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iotsitewise.html#IoTSiteWise) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.13.0](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-iotsitewise docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iotsitewise/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-iotsitewise](#mypy-boto3-iotsitewise) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `IoTSiteWise`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `IoTSiteWise` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-iotsitewise +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[iotsitewise]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[iotsitewise]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`IoTSiteWiseClient` provides annotations for `boto3.client("iotsitewise")`. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_iotsitewise.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient +from mypy_boto3_iotsitewise.paginator import ( + GetAssetPropertyAggregatesPaginator, + GetAssetPropertyValueHistoryPaginator, + GetInterpolatedAssetPropertyValuesPaginator, + ListAccessPoliciesPaginator, + ListAssetModelPropertiesPaginator, + ListAssetModelsPaginator, + ListAssetPropertiesPaginator, + ListAssetRelationshipsPaginator, + ListAssetsPaginator, + ListAssociatedAssetsPaginator, + ListBulkImportJobsPaginator, + ListDashboardsPaginator, + ListGatewaysPaginator, + ListPortalsPaginator, + ListProjectAssetsPaginator, + ListProjectsPaginator, + ListTimeSeriesPaginator, +) + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_asset_property_aggregates_paginator: GetAssetPropertyAggregatesPaginator = client.get_paginator( + "get_asset_property_aggregates" +) +get_asset_property_value_history_paginator: GetAssetPropertyValueHistoryPaginator = ( + client.get_paginator("get_asset_property_value_history") +) +get_interpolated_asset_property_values_paginator: GetInterpolatedAssetPropertyValuesPaginator = ( + client.get_paginator("get_interpolated_asset_property_values") +) +list_access_policies_paginator: ListAccessPoliciesPaginator = client.get_paginator( + "list_access_policies" +) +list_asset_model_properties_paginator: ListAssetModelPropertiesPaginator = client.get_paginator( + "list_asset_model_properties" +) +list_asset_models_paginator: ListAssetModelsPaginator = client.get_paginator("list_asset_models") +list_asset_properties_paginator: ListAssetPropertiesPaginator = client.get_paginator( + "list_asset_properties" +) +list_asset_relationships_paginator: ListAssetRelationshipsPaginator = client.get_paginator( + "list_asset_relationships" +) +list_assets_paginator: ListAssetsPaginator = client.get_paginator("list_assets") +list_associated_assets_paginator: ListAssociatedAssetsPaginator = client.get_paginator( + "list_associated_assets" +) +list_bulk_import_jobs_paginator: ListBulkImportJobsPaginator = client.get_paginator( + "list_bulk_import_jobs" +) +list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards") +list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways") +list_portals_paginator: ListPortalsPaginator = client.get_paginator("list_portals") +list_project_assets_paginator: ListProjectAssetsPaginator = client.get_paginator( + "list_project_assets" +) +list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects") +list_time_series_paginator: ListTimeSeriesPaginator = client.get_paginator("list_time_series") +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_iotsitewise.waiter` module contains type annotations for all +waiters. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient +from mypy_boto3_iotsitewise.waiter import ( + AssetActiveWaiter, + AssetModelActiveWaiter, + AssetModelNotExistsWaiter, + AssetNotExistsWaiter, + PortalActiveWaiter, + PortalNotExistsWaiter, +) + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +asset_active_waiter: AssetActiveWaiter = client.get_waiter("asset_active") +asset_model_active_waiter: AssetModelActiveWaiter = client.get_waiter("asset_model_active") +asset_model_not_exists_waiter: AssetModelNotExistsWaiter = client.get_waiter( + "asset_model_not_exists" +) +asset_not_exists_waiter: AssetNotExistsWaiter = client.get_waiter("asset_not_exists") +portal_active_waiter: PortalActiveWaiter = client.get_waiter("portal_active") +portal_not_exists_waiter: PortalNotExistsWaiter = client.get_waiter("portal_not_exists") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_iotsitewise.literals` module contains literals extracted from +shapes that can be used in user code for type checking. + +```python +from mypy_boto3_iotsitewise.literals import ( + 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, +) + + +def check_value(value: AggregateTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_iotsitewise.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_iotsitewise.type_defs import ( + AggregatesTypeDef, + AlarmsTypeDef, + AssetErrorDetailsTypeDef, + AssetHierarchyInfoTypeDef, + AssetHierarchyTypeDef, + AssetModelHierarchyDefinitionTypeDef, + AssetModelHierarchyTypeDef, + PropertyNotificationTypeDef, + TimeInNanosTypeDef, + VariantTypeDef, + AssociateAssetsRequestRequestTypeDef, + AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef, + AttributeTypeDef, + BatchAssociateProjectAssetsRequestRequestTypeDef, + ResponseMetadataTypeDef, + BatchDisassociateProjectAssetsRequestRequestTypeDef, + BatchGetAssetPropertyAggregatesEntryTypeDef, + BatchGetAssetPropertyAggregatesErrorEntryTypeDef, + BatchGetAssetPropertyAggregatesErrorInfoTypeDef, + BatchGetAssetPropertyValueEntryTypeDef, + BatchGetAssetPropertyValueErrorEntryTypeDef, + BatchGetAssetPropertyValueErrorInfoTypeDef, + BatchGetAssetPropertyValueHistoryEntryTypeDef, + BatchGetAssetPropertyValueHistoryErrorEntryTypeDef, + BatchGetAssetPropertyValueHistoryErrorInfoTypeDef, + ConfigurationErrorDetailsTypeDef, + CreateAssetRequestRequestTypeDef, + ErrorReportLocationTypeDef, + FileTypeDef, + CreateDashboardRequestRequestTypeDef, + ImageFileTypeDef, + CreateProjectRequestRequestTypeDef, + CsvTypeDef, + CustomerManagedS3StorageTypeDef, + DashboardSummaryTypeDef, + DeleteAccessPolicyRequestRequestTypeDef, + DeleteAssetModelRequestRequestTypeDef, + DeleteAssetRequestRequestTypeDef, + DeleteDashboardRequestRequestTypeDef, + DeleteGatewayRequestRequestTypeDef, + DeletePortalRequestRequestTypeDef, + DeleteProjectRequestRequestTypeDef, + DeleteTimeSeriesRequestRequestTypeDef, + DescribeAccessPolicyRequestRequestTypeDef, + WaiterConfigTypeDef, + DescribeAssetModelRequestRequestTypeDef, + DescribeAssetPropertyRequestRequestTypeDef, + DescribeAssetRequestRequestTypeDef, + DescribeBulkImportJobRequestRequestTypeDef, + DescribeDashboardRequestRequestTypeDef, + DescribeGatewayCapabilityConfigurationRequestRequestTypeDef, + DescribeGatewayRequestRequestTypeDef, + GatewayCapabilitySummaryTypeDef, + LoggingOptionsTypeDef, + DescribePortalRequestRequestTypeDef, + ImageLocationTypeDef, + DescribeProjectRequestRequestTypeDef, + RetentionPeriodTypeDef, + DescribeTimeSeriesRequestRequestTypeDef, + DetailedErrorTypeDef, + DisassociateAssetsRequestRequestTypeDef, + DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef, + VariableValueTypeDef, + ForwardingConfigTypeDef, + GreengrassTypeDef, + GreengrassV2TypeDef, + PaginatorConfigTypeDef, + GetAssetPropertyAggregatesRequestRequestTypeDef, + GetAssetPropertyValueHistoryRequestRequestTypeDef, + GetAssetPropertyValueRequestRequestTypeDef, + GetInterpolatedAssetPropertyValuesRequestRequestTypeDef, + GroupIdentityTypeDef, + IAMRoleIdentityTypeDef, + IAMUserIdentityTypeDef, + UserIdentityTypeDef, + JobSummaryTypeDef, + ListAccessPoliciesRequestRequestTypeDef, + ListAssetModelPropertiesRequestRequestTypeDef, + ListAssetModelsRequestRequestTypeDef, + ListAssetPropertiesRequestRequestTypeDef, + ListAssetRelationshipsRequestRequestTypeDef, + ListAssetsRequestRequestTypeDef, + ListAssociatedAssetsRequestRequestTypeDef, + ListBulkImportJobsRequestRequestTypeDef, + ListDashboardsRequestRequestTypeDef, + ListGatewaysRequestRequestTypeDef, + ListPortalsRequestRequestTypeDef, + ListProjectAssetsRequestRequestTypeDef, + ListProjectsRequestRequestTypeDef, + ProjectSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListTimeSeriesRequestRequestTypeDef, + TimeSeriesSummaryTypeDef, + MetricProcessingConfigTypeDef, + TumblingWindowTypeDef, + MonitorErrorDetailsTypeDef, + PortalResourceTypeDef, + ProjectResourceTypeDef, + PutDefaultEncryptionConfigurationRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAssetPropertyRequestRequestTypeDef, + UpdateAssetRequestRequestTypeDef, + UpdateDashboardRequestRequestTypeDef, + UpdateGatewayCapabilityConfigurationRequestRequestTypeDef, + UpdateGatewayRequestRequestTypeDef, + UpdateProjectRequestRequestTypeDef, + AggregatedValueTypeDef, + AssetRelationshipSummaryTypeDef, + AssetPropertySummaryTypeDef, + AssetPropertyTypeDef, + BatchPutAssetPropertyErrorTypeDef, + AssetPropertyValueTypeDef, + InterpolatedAssetPropertyValueTypeDef, + BatchAssociateProjectAssetsResponseTypeDef, + BatchDisassociateProjectAssetsResponseTypeDef, + CreateAccessPolicyResponseTypeDef, + CreateBulkImportJobResponseTypeDef, + CreateDashboardResponseTypeDef, + CreateGatewayResponseTypeDef, + CreateProjectResponseTypeDef, + DescribeDashboardResponseTypeDef, + DescribeGatewayCapabilityConfigurationResponseTypeDef, + DescribeProjectResponseTypeDef, + DescribeTimeSeriesResponseTypeDef, + EmptyResponseMetadataTypeDef, + ListProjectAssetsResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateGatewayCapabilityConfigurationResponseTypeDef, + 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, + GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef, + GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef, + GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef, + ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef, + ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef, + ListAssetModelsRequestListAssetModelsPaginateTypeDef, + ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef, + ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef, + ListAssetsRequestListAssetsPaginateTypeDef, + ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef, + ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef, + ListDashboardsRequestListDashboardsPaginateTypeDef, + ListGatewaysRequestListGatewaysPaginateTypeDef, + ListPortalsRequestListPortalsPaginateTypeDef, + ListProjectAssetsRequestListProjectAssetsPaginateTypeDef, + ListProjectsRequestListProjectsPaginateTypeDef, + ListTimeSeriesRequestListTimeSeriesPaginateTypeDef, + 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, +) + + +def get_structure() -> AggregatesTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-iotsitewise` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iotsitewise/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package -n python3-mypy-boto3-iotsitewise +Summary: Type annotations for boto3.IoTSiteWise 1.26.96 service generated with mypy-boto3-builder 7.13.0 +Provides: python-mypy-boto3-iotsitewise +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-iotsitewise +<a id="mypy-boto3-iotsitewise"></a> + +# mypy-boto3-iotsitewise + +[](https://pypi.org/project/mypy-boto3-iotsitewise) +[](https://pypi.org/project/mypy-boto3-iotsitewise) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-iotsitewise) + + + +Type annotations for +[boto3.IoTSiteWise 1.26.96](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iotsitewise.html#IoTSiteWise) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.13.0](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-iotsitewise docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iotsitewise/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-iotsitewise](#mypy-boto3-iotsitewise) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `IoTSiteWise`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `IoTSiteWise` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-iotsitewise +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[iotsitewise]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[iotsitewise]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`IoTSiteWiseClient` provides annotations for `boto3.client("iotsitewise")`. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_iotsitewise.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient +from mypy_boto3_iotsitewise.paginator import ( + GetAssetPropertyAggregatesPaginator, + GetAssetPropertyValueHistoryPaginator, + GetInterpolatedAssetPropertyValuesPaginator, + ListAccessPoliciesPaginator, + ListAssetModelPropertiesPaginator, + ListAssetModelsPaginator, + ListAssetPropertiesPaginator, + ListAssetRelationshipsPaginator, + ListAssetsPaginator, + ListAssociatedAssetsPaginator, + ListBulkImportJobsPaginator, + ListDashboardsPaginator, + ListGatewaysPaginator, + ListPortalsPaginator, + ListProjectAssetsPaginator, + ListProjectsPaginator, + ListTimeSeriesPaginator, +) + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_asset_property_aggregates_paginator: GetAssetPropertyAggregatesPaginator = client.get_paginator( + "get_asset_property_aggregates" +) +get_asset_property_value_history_paginator: GetAssetPropertyValueHistoryPaginator = ( + client.get_paginator("get_asset_property_value_history") +) +get_interpolated_asset_property_values_paginator: GetInterpolatedAssetPropertyValuesPaginator = ( + client.get_paginator("get_interpolated_asset_property_values") +) +list_access_policies_paginator: ListAccessPoliciesPaginator = client.get_paginator( + "list_access_policies" +) +list_asset_model_properties_paginator: ListAssetModelPropertiesPaginator = client.get_paginator( + "list_asset_model_properties" +) +list_asset_models_paginator: ListAssetModelsPaginator = client.get_paginator("list_asset_models") +list_asset_properties_paginator: ListAssetPropertiesPaginator = client.get_paginator( + "list_asset_properties" +) +list_asset_relationships_paginator: ListAssetRelationshipsPaginator = client.get_paginator( + "list_asset_relationships" +) +list_assets_paginator: ListAssetsPaginator = client.get_paginator("list_assets") +list_associated_assets_paginator: ListAssociatedAssetsPaginator = client.get_paginator( + "list_associated_assets" +) +list_bulk_import_jobs_paginator: ListBulkImportJobsPaginator = client.get_paginator( + "list_bulk_import_jobs" +) +list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards") +list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways") +list_portals_paginator: ListPortalsPaginator = client.get_paginator("list_portals") +list_project_assets_paginator: ListProjectAssetsPaginator = client.get_paginator( + "list_project_assets" +) +list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects") +list_time_series_paginator: ListTimeSeriesPaginator = client.get_paginator("list_time_series") +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_iotsitewise.waiter` module contains type annotations for all +waiters. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient +from mypy_boto3_iotsitewise.waiter import ( + AssetActiveWaiter, + AssetModelActiveWaiter, + AssetModelNotExistsWaiter, + AssetNotExistsWaiter, + PortalActiveWaiter, + PortalNotExistsWaiter, +) + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +asset_active_waiter: AssetActiveWaiter = client.get_waiter("asset_active") +asset_model_active_waiter: AssetModelActiveWaiter = client.get_waiter("asset_model_active") +asset_model_not_exists_waiter: AssetModelNotExistsWaiter = client.get_waiter( + "asset_model_not_exists" +) +asset_not_exists_waiter: AssetNotExistsWaiter = client.get_waiter("asset_not_exists") +portal_active_waiter: PortalActiveWaiter = client.get_waiter("portal_active") +portal_not_exists_waiter: PortalNotExistsWaiter = client.get_waiter("portal_not_exists") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_iotsitewise.literals` module contains literals extracted from +shapes that can be used in user code for type checking. + +```python +from mypy_boto3_iotsitewise.literals import ( + 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, +) + + +def check_value(value: AggregateTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_iotsitewise.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_iotsitewise.type_defs import ( + AggregatesTypeDef, + AlarmsTypeDef, + AssetErrorDetailsTypeDef, + AssetHierarchyInfoTypeDef, + AssetHierarchyTypeDef, + AssetModelHierarchyDefinitionTypeDef, + AssetModelHierarchyTypeDef, + PropertyNotificationTypeDef, + TimeInNanosTypeDef, + VariantTypeDef, + AssociateAssetsRequestRequestTypeDef, + AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef, + AttributeTypeDef, + BatchAssociateProjectAssetsRequestRequestTypeDef, + ResponseMetadataTypeDef, + BatchDisassociateProjectAssetsRequestRequestTypeDef, + BatchGetAssetPropertyAggregatesEntryTypeDef, + BatchGetAssetPropertyAggregatesErrorEntryTypeDef, + BatchGetAssetPropertyAggregatesErrorInfoTypeDef, + BatchGetAssetPropertyValueEntryTypeDef, + BatchGetAssetPropertyValueErrorEntryTypeDef, + BatchGetAssetPropertyValueErrorInfoTypeDef, + BatchGetAssetPropertyValueHistoryEntryTypeDef, + BatchGetAssetPropertyValueHistoryErrorEntryTypeDef, + BatchGetAssetPropertyValueHistoryErrorInfoTypeDef, + ConfigurationErrorDetailsTypeDef, + CreateAssetRequestRequestTypeDef, + ErrorReportLocationTypeDef, + FileTypeDef, + CreateDashboardRequestRequestTypeDef, + ImageFileTypeDef, + CreateProjectRequestRequestTypeDef, + CsvTypeDef, + CustomerManagedS3StorageTypeDef, + DashboardSummaryTypeDef, + DeleteAccessPolicyRequestRequestTypeDef, + DeleteAssetModelRequestRequestTypeDef, + DeleteAssetRequestRequestTypeDef, + DeleteDashboardRequestRequestTypeDef, + DeleteGatewayRequestRequestTypeDef, + DeletePortalRequestRequestTypeDef, + DeleteProjectRequestRequestTypeDef, + DeleteTimeSeriesRequestRequestTypeDef, + DescribeAccessPolicyRequestRequestTypeDef, + WaiterConfigTypeDef, + DescribeAssetModelRequestRequestTypeDef, + DescribeAssetPropertyRequestRequestTypeDef, + DescribeAssetRequestRequestTypeDef, + DescribeBulkImportJobRequestRequestTypeDef, + DescribeDashboardRequestRequestTypeDef, + DescribeGatewayCapabilityConfigurationRequestRequestTypeDef, + DescribeGatewayRequestRequestTypeDef, + GatewayCapabilitySummaryTypeDef, + LoggingOptionsTypeDef, + DescribePortalRequestRequestTypeDef, + ImageLocationTypeDef, + DescribeProjectRequestRequestTypeDef, + RetentionPeriodTypeDef, + DescribeTimeSeriesRequestRequestTypeDef, + DetailedErrorTypeDef, + DisassociateAssetsRequestRequestTypeDef, + DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef, + VariableValueTypeDef, + ForwardingConfigTypeDef, + GreengrassTypeDef, + GreengrassV2TypeDef, + PaginatorConfigTypeDef, + GetAssetPropertyAggregatesRequestRequestTypeDef, + GetAssetPropertyValueHistoryRequestRequestTypeDef, + GetAssetPropertyValueRequestRequestTypeDef, + GetInterpolatedAssetPropertyValuesRequestRequestTypeDef, + GroupIdentityTypeDef, + IAMRoleIdentityTypeDef, + IAMUserIdentityTypeDef, + UserIdentityTypeDef, + JobSummaryTypeDef, + ListAccessPoliciesRequestRequestTypeDef, + ListAssetModelPropertiesRequestRequestTypeDef, + ListAssetModelsRequestRequestTypeDef, + ListAssetPropertiesRequestRequestTypeDef, + ListAssetRelationshipsRequestRequestTypeDef, + ListAssetsRequestRequestTypeDef, + ListAssociatedAssetsRequestRequestTypeDef, + ListBulkImportJobsRequestRequestTypeDef, + ListDashboardsRequestRequestTypeDef, + ListGatewaysRequestRequestTypeDef, + ListPortalsRequestRequestTypeDef, + ListProjectAssetsRequestRequestTypeDef, + ListProjectsRequestRequestTypeDef, + ProjectSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListTimeSeriesRequestRequestTypeDef, + TimeSeriesSummaryTypeDef, + MetricProcessingConfigTypeDef, + TumblingWindowTypeDef, + MonitorErrorDetailsTypeDef, + PortalResourceTypeDef, + ProjectResourceTypeDef, + PutDefaultEncryptionConfigurationRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAssetPropertyRequestRequestTypeDef, + UpdateAssetRequestRequestTypeDef, + UpdateDashboardRequestRequestTypeDef, + UpdateGatewayCapabilityConfigurationRequestRequestTypeDef, + UpdateGatewayRequestRequestTypeDef, + UpdateProjectRequestRequestTypeDef, + AggregatedValueTypeDef, + AssetRelationshipSummaryTypeDef, + AssetPropertySummaryTypeDef, + AssetPropertyTypeDef, + BatchPutAssetPropertyErrorTypeDef, + AssetPropertyValueTypeDef, + InterpolatedAssetPropertyValueTypeDef, + BatchAssociateProjectAssetsResponseTypeDef, + BatchDisassociateProjectAssetsResponseTypeDef, + CreateAccessPolicyResponseTypeDef, + CreateBulkImportJobResponseTypeDef, + CreateDashboardResponseTypeDef, + CreateGatewayResponseTypeDef, + CreateProjectResponseTypeDef, + DescribeDashboardResponseTypeDef, + DescribeGatewayCapabilityConfigurationResponseTypeDef, + DescribeProjectResponseTypeDef, + DescribeTimeSeriesResponseTypeDef, + EmptyResponseMetadataTypeDef, + ListProjectAssetsResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateGatewayCapabilityConfigurationResponseTypeDef, + 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, + GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef, + GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef, + GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef, + ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef, + ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef, + ListAssetModelsRequestListAssetModelsPaginateTypeDef, + ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef, + ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef, + ListAssetsRequestListAssetsPaginateTypeDef, + ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef, + ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef, + ListDashboardsRequestListDashboardsPaginateTypeDef, + ListGatewaysRequestListGatewaysPaginateTypeDef, + ListPortalsRequestListPortalsPaginateTypeDef, + ListProjectAssetsRequestListProjectAssetsPaginateTypeDef, + ListProjectsRequestListProjectsPaginateTypeDef, + ListTimeSeriesRequestListTimeSeriesPaginateTypeDef, + 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, +) + + +def get_structure() -> AggregatesTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-iotsitewise` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iotsitewise/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%package help +Summary: Development documents and examples for mypy-boto3-iotsitewise +Provides: python3-mypy-boto3-iotsitewise-doc +%description help +<a id="mypy-boto3-iotsitewise"></a> + +# mypy-boto3-iotsitewise + +[](https://pypi.org/project/mypy-boto3-iotsitewise) +[](https://pypi.org/project/mypy-boto3-iotsitewise) +[](https://mypy-boto3-builder.readthedocs.io/) +[](https://pypistats.org/packages/mypy-boto3-iotsitewise) + + + +Type annotations for +[boto3.IoTSiteWise 1.26.96](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iotsitewise.html#IoTSiteWise) +service compatible with [VSCode](https://code.visualstudio.com/), +[PyCharm](https://www.jetbrains.com/pycharm/), +[Emacs](https://www.gnu.org/software/emacs/), +[Sublime Text](https://www.sublimetext.com/), +[mypy](https://github.com/python/mypy), +[pyright](https://github.com/microsoft/pyright) and other tools. + +Generated by +[mypy-boto3-builder 7.13.0](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-iotsitewise docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iotsitewise/). + +See how it helps to find and fix potential bugs: + + + +- [mypy-boto3-iotsitewise](#mypy-boto3-iotsitewise) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Waiters annotations](#waiters-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + +<a id="how-to-install"></a> + +## How to install + +<a id="vscode-extension"></a> + +### VSCode extension + +Add +[AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide) +extension to your VSCode and run `AWS boto3: Quick Start` command. + +Click `Modify` and select `boto3 common` and `IoTSiteWise`. + +<a id="from-pypi-with-pip"></a> + +### From PyPI with pip + +Install `boto3-stubs` for `IoTSiteWise` service. + +```bash +# 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 +``` + +<a id="how-to-uninstall"></a> + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-iotsitewise +``` + +<a id="usage"></a> + +## Usage + +<a id="vscode"></a> + +### VSCode + +- Install + [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python) +- Install + [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) +- Set `Pylance` as your Python Language Server +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + +<a id="pycharm"></a> + +### PyCharm + +Install `boto3-stubs-lite[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[iotsitewise]'` +``` + +Both type checking and code completion should now work. Explicit type +annotations **are required**. + +Use `boto3-stubs` package instead for implicit type discovery. + +<a id="emacs"></a> + +### Emacs + +- Install `boto3-stubs` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +- Install [use-package](https://github.com/jwiegley/use-package), + [lsp](https://github.com/emacs-lsp/lsp-mode/), + [company](https://github.com/company-mode/company-mode) and + [flycheck](https://github.com/flycheck/flycheck) packages +- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package + +```elisp +(use-package lsp-pyright + :ensure t + :hook (python-mode . (lambda () + (require 'lsp-pyright) + (lsp))) ; or lsp-deferred + :init (when (executable-find "python3") + (setq lsp-pyright-python-executable-cmd "python3")) + ) +``` + +- Make sure emacs uses the environment where you have installed `boto3-stubs` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="sublime-text"></a> + +### Sublime Text + +- Install `boto3-stubs[iotsitewise]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="other-ides"></a> + +### Other IDEs + +Not tested, but as long as your IDE supports `mypy` or `pyright`, everything +should work. + +<a id="mypy"></a> + +### mypy + +- Install `mypy`: `python -m pip install mypy` +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="pyright"></a> + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[iotsitewise]` in your environment: + +```bash +python -m pip install 'boto3-stubs[iotsitewise]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + +<a id="explicit-type-annotations"></a> + +## Explicit type annotations + +<a id="client-annotations"></a> + +### Client annotations + +`IoTSiteWiseClient` provides annotations for `boto3.client("iotsitewise")`. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# now client usage is checked by mypy and IDE should provide code completion +``` + +<a id="paginators-annotations"></a> + +### Paginators annotations + +`mypy_boto3_iotsitewise.paginator` module contains type annotations for all +paginators. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient +from mypy_boto3_iotsitewise.paginator import ( + GetAssetPropertyAggregatesPaginator, + GetAssetPropertyValueHistoryPaginator, + GetInterpolatedAssetPropertyValuesPaginator, + ListAccessPoliciesPaginator, + ListAssetModelPropertiesPaginator, + ListAssetModelsPaginator, + ListAssetPropertiesPaginator, + ListAssetRelationshipsPaginator, + ListAssetsPaginator, + ListAssociatedAssetsPaginator, + ListBulkImportJobsPaginator, + ListDashboardsPaginator, + ListGatewaysPaginator, + ListPortalsPaginator, + ListProjectAssetsPaginator, + ListProjectsPaginator, + ListTimeSeriesPaginator, +) + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +get_asset_property_aggregates_paginator: GetAssetPropertyAggregatesPaginator = client.get_paginator( + "get_asset_property_aggregates" +) +get_asset_property_value_history_paginator: GetAssetPropertyValueHistoryPaginator = ( + client.get_paginator("get_asset_property_value_history") +) +get_interpolated_asset_property_values_paginator: GetInterpolatedAssetPropertyValuesPaginator = ( + client.get_paginator("get_interpolated_asset_property_values") +) +list_access_policies_paginator: ListAccessPoliciesPaginator = client.get_paginator( + "list_access_policies" +) +list_asset_model_properties_paginator: ListAssetModelPropertiesPaginator = client.get_paginator( + "list_asset_model_properties" +) +list_asset_models_paginator: ListAssetModelsPaginator = client.get_paginator("list_asset_models") +list_asset_properties_paginator: ListAssetPropertiesPaginator = client.get_paginator( + "list_asset_properties" +) +list_asset_relationships_paginator: ListAssetRelationshipsPaginator = client.get_paginator( + "list_asset_relationships" +) +list_assets_paginator: ListAssetsPaginator = client.get_paginator("list_assets") +list_associated_assets_paginator: ListAssociatedAssetsPaginator = client.get_paginator( + "list_associated_assets" +) +list_bulk_import_jobs_paginator: ListBulkImportJobsPaginator = client.get_paginator( + "list_bulk_import_jobs" +) +list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards") +list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways") +list_portals_paginator: ListPortalsPaginator = client.get_paginator("list_portals") +list_project_assets_paginator: ListProjectAssetsPaginator = client.get_paginator( + "list_project_assets" +) +list_projects_paginator: ListProjectsPaginator = client.get_paginator("list_projects") +list_time_series_paginator: ListTimeSeriesPaginator = client.get_paginator("list_time_series") +``` + +<a id="waiters-annotations"></a> + +### Waiters annotations + +`mypy_boto3_iotsitewise.waiter` module contains type annotations for all +waiters. + +```python +from boto3.session import Session + +from mypy_boto3_iotsitewise import IoTSiteWiseClient +from mypy_boto3_iotsitewise.waiter import ( + AssetActiveWaiter, + AssetModelActiveWaiter, + AssetModelNotExistsWaiter, + AssetNotExistsWaiter, + PortalActiveWaiter, + PortalNotExistsWaiter, +) + +client: IoTSiteWiseClient = Session().client("iotsitewise") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +asset_active_waiter: AssetActiveWaiter = client.get_waiter("asset_active") +asset_model_active_waiter: AssetModelActiveWaiter = client.get_waiter("asset_model_active") +asset_model_not_exists_waiter: AssetModelNotExistsWaiter = client.get_waiter( + "asset_model_not_exists" +) +asset_not_exists_waiter: AssetNotExistsWaiter = client.get_waiter("asset_not_exists") +portal_active_waiter: PortalActiveWaiter = client.get_waiter("portal_active") +portal_not_exists_waiter: PortalNotExistsWaiter = client.get_waiter("portal_not_exists") +``` + +<a id="literals"></a> + +### Literals + +`mypy_boto3_iotsitewise.literals` module contains literals extracted from +shapes that can be used in user code for type checking. + +```python +from mypy_boto3_iotsitewise.literals import ( + 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, +) + + +def check_value(value: AggregateTypeType) -> bool: + ... +``` + +<a id="typed-dictionaries"></a> + +### Typed dictionaries + +`mypy_boto3_iotsitewise.type_defs` module contains structures and shapes +assembled to typed dictionaries for additional type checking. + +```python +from mypy_boto3_iotsitewise.type_defs import ( + AggregatesTypeDef, + AlarmsTypeDef, + AssetErrorDetailsTypeDef, + AssetHierarchyInfoTypeDef, + AssetHierarchyTypeDef, + AssetModelHierarchyDefinitionTypeDef, + AssetModelHierarchyTypeDef, + PropertyNotificationTypeDef, + TimeInNanosTypeDef, + VariantTypeDef, + AssociateAssetsRequestRequestTypeDef, + AssociateTimeSeriesToAssetPropertyRequestRequestTypeDef, + AttributeTypeDef, + BatchAssociateProjectAssetsRequestRequestTypeDef, + ResponseMetadataTypeDef, + BatchDisassociateProjectAssetsRequestRequestTypeDef, + BatchGetAssetPropertyAggregatesEntryTypeDef, + BatchGetAssetPropertyAggregatesErrorEntryTypeDef, + BatchGetAssetPropertyAggregatesErrorInfoTypeDef, + BatchGetAssetPropertyValueEntryTypeDef, + BatchGetAssetPropertyValueErrorEntryTypeDef, + BatchGetAssetPropertyValueErrorInfoTypeDef, + BatchGetAssetPropertyValueHistoryEntryTypeDef, + BatchGetAssetPropertyValueHistoryErrorEntryTypeDef, + BatchGetAssetPropertyValueHistoryErrorInfoTypeDef, + ConfigurationErrorDetailsTypeDef, + CreateAssetRequestRequestTypeDef, + ErrorReportLocationTypeDef, + FileTypeDef, + CreateDashboardRequestRequestTypeDef, + ImageFileTypeDef, + CreateProjectRequestRequestTypeDef, + CsvTypeDef, + CustomerManagedS3StorageTypeDef, + DashboardSummaryTypeDef, + DeleteAccessPolicyRequestRequestTypeDef, + DeleteAssetModelRequestRequestTypeDef, + DeleteAssetRequestRequestTypeDef, + DeleteDashboardRequestRequestTypeDef, + DeleteGatewayRequestRequestTypeDef, + DeletePortalRequestRequestTypeDef, + DeleteProjectRequestRequestTypeDef, + DeleteTimeSeriesRequestRequestTypeDef, + DescribeAccessPolicyRequestRequestTypeDef, + WaiterConfigTypeDef, + DescribeAssetModelRequestRequestTypeDef, + DescribeAssetPropertyRequestRequestTypeDef, + DescribeAssetRequestRequestTypeDef, + DescribeBulkImportJobRequestRequestTypeDef, + DescribeDashboardRequestRequestTypeDef, + DescribeGatewayCapabilityConfigurationRequestRequestTypeDef, + DescribeGatewayRequestRequestTypeDef, + GatewayCapabilitySummaryTypeDef, + LoggingOptionsTypeDef, + DescribePortalRequestRequestTypeDef, + ImageLocationTypeDef, + DescribeProjectRequestRequestTypeDef, + RetentionPeriodTypeDef, + DescribeTimeSeriesRequestRequestTypeDef, + DetailedErrorTypeDef, + DisassociateAssetsRequestRequestTypeDef, + DisassociateTimeSeriesFromAssetPropertyRequestRequestTypeDef, + VariableValueTypeDef, + ForwardingConfigTypeDef, + GreengrassTypeDef, + GreengrassV2TypeDef, + PaginatorConfigTypeDef, + GetAssetPropertyAggregatesRequestRequestTypeDef, + GetAssetPropertyValueHistoryRequestRequestTypeDef, + GetAssetPropertyValueRequestRequestTypeDef, + GetInterpolatedAssetPropertyValuesRequestRequestTypeDef, + GroupIdentityTypeDef, + IAMRoleIdentityTypeDef, + IAMUserIdentityTypeDef, + UserIdentityTypeDef, + JobSummaryTypeDef, + ListAccessPoliciesRequestRequestTypeDef, + ListAssetModelPropertiesRequestRequestTypeDef, + ListAssetModelsRequestRequestTypeDef, + ListAssetPropertiesRequestRequestTypeDef, + ListAssetRelationshipsRequestRequestTypeDef, + ListAssetsRequestRequestTypeDef, + ListAssociatedAssetsRequestRequestTypeDef, + ListBulkImportJobsRequestRequestTypeDef, + ListDashboardsRequestRequestTypeDef, + ListGatewaysRequestRequestTypeDef, + ListPortalsRequestRequestTypeDef, + ListProjectAssetsRequestRequestTypeDef, + ListProjectsRequestRequestTypeDef, + ProjectSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + ListTimeSeriesRequestRequestTypeDef, + TimeSeriesSummaryTypeDef, + MetricProcessingConfigTypeDef, + TumblingWindowTypeDef, + MonitorErrorDetailsTypeDef, + PortalResourceTypeDef, + ProjectResourceTypeDef, + PutDefaultEncryptionConfigurationRequestRequestTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateAssetPropertyRequestRequestTypeDef, + UpdateAssetRequestRequestTypeDef, + UpdateDashboardRequestRequestTypeDef, + UpdateGatewayCapabilityConfigurationRequestRequestTypeDef, + UpdateGatewayRequestRequestTypeDef, + UpdateProjectRequestRequestTypeDef, + AggregatedValueTypeDef, + AssetRelationshipSummaryTypeDef, + AssetPropertySummaryTypeDef, + AssetPropertyTypeDef, + BatchPutAssetPropertyErrorTypeDef, + AssetPropertyValueTypeDef, + InterpolatedAssetPropertyValueTypeDef, + BatchAssociateProjectAssetsResponseTypeDef, + BatchDisassociateProjectAssetsResponseTypeDef, + CreateAccessPolicyResponseTypeDef, + CreateBulkImportJobResponseTypeDef, + CreateDashboardResponseTypeDef, + CreateGatewayResponseTypeDef, + CreateProjectResponseTypeDef, + DescribeDashboardResponseTypeDef, + DescribeGatewayCapabilityConfigurationResponseTypeDef, + DescribeProjectResponseTypeDef, + DescribeTimeSeriesResponseTypeDef, + EmptyResponseMetadataTypeDef, + ListProjectAssetsResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateGatewayCapabilityConfigurationResponseTypeDef, + 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, + GetAssetPropertyAggregatesRequestGetAssetPropertyAggregatesPaginateTypeDef, + GetAssetPropertyValueHistoryRequestGetAssetPropertyValueHistoryPaginateTypeDef, + GetInterpolatedAssetPropertyValuesRequestGetInterpolatedAssetPropertyValuesPaginateTypeDef, + ListAccessPoliciesRequestListAccessPoliciesPaginateTypeDef, + ListAssetModelPropertiesRequestListAssetModelPropertiesPaginateTypeDef, + ListAssetModelsRequestListAssetModelsPaginateTypeDef, + ListAssetPropertiesRequestListAssetPropertiesPaginateTypeDef, + ListAssetRelationshipsRequestListAssetRelationshipsPaginateTypeDef, + ListAssetsRequestListAssetsPaginateTypeDef, + ListAssociatedAssetsRequestListAssociatedAssetsPaginateTypeDef, + ListBulkImportJobsRequestListBulkImportJobsPaginateTypeDef, + ListDashboardsRequestListDashboardsPaginateTypeDef, + ListGatewaysRequestListGatewaysPaginateTypeDef, + ListPortalsRequestListPortalsPaginateTypeDef, + ListProjectAssetsRequestListProjectAssetsPaginateTypeDef, + ListProjectsRequestListProjectsPaginateTypeDef, + ListTimeSeriesRequestListTimeSeriesPaginateTypeDef, + 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, +) + + +def get_structure() -> AggregatesTypeDef: + return {...} +``` + +<a id="how-it-works"></a> + +## How it works + +Fully automated +[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully +generates type annotations for each service, patiently waiting for `boto3` +updates. It delivers a drop-in type annotations for you and makes sure that: + +- All available `boto3` services are covered. +- Each public class and method of every `boto3` service gets valid type + annotations extracted from the documentation (blame `botocore` docs if types + are incorrect). +- Type annotations include up-to-date documentation. +- Link to documentation is provided for every method. +- Code is processed by [black](https://github.com/psf/black) and + [isort](https://github.com/PyCQA/isort) for readability. + +<a id="what's-new"></a> + +## What's new + +<a id="implemented-features"></a> + +### Implemented features + +- Fully type annotated `boto3`, `botocore` and `aiobotocore` libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type + annotations for each service +- Generated `TypeDefs` for each service +- Generated `Literals` for each service +- Auto discovery of types for `boto3.client` and `boto3.session` calls +- Auto discovery of types for `session.client` and `session.session` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + +<a id="latest-changes"></a> + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + +<a id="versioning"></a> + +## Versioning + +`mypy-boto3-iotsitewise` version is the same as related `boto3` version and +follows [PEP 440](https://www.python.org/dev/peps/pep-0440/) format. + +<a id="thank-you"></a> + +## Thank you + +- [Allie Fitter](https://github.com/alliefitter) for + [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/), + this package is based on top of his work +- [black](https://github.com/psf/black) developers for an awesome formatting + tool +- [Timothy Edmund Crosley](https://github.com/timothycrosley) for + [isort](https://github.com/PyCQA/isort) and how flexible it is +- [mypy](https://github.com/python/mypy) developers for doing all dirty work + for us +- [pyright](https://github.com/microsoft/pyright) team for the new era of typed + Python + +<a id="documentation"></a> + +## Documentation + +All services type annotations can be found in +[boto3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iotsitewise/) + +<a id="support-and-contributing"></a> + +## Support and contributing + +This package is auto-generated. Please reports any bugs or request new features +in [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) +repository. + + +%prep +%autosetup -n mypy-boto3-iotsitewise-1.26.96 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-iotsitewise -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.26.96-1 +- Package Spec generated |