types-aiobotocore-iotsitewise


Nametypes-aiobotocore-iotsitewise JSON
Version 2.12.0 PyPI version JSON
download
home_pagehttps://github.com/youtype/mypy_boto3_builder
SummaryType annotations for aiobotocore.IoTSiteWise 2.12.0 service generated with mypy-boto3-builder 7.23.2
upload_time2024-02-29 01:36:32
maintainer
docs_urlNone
authorVlad Emelianov
requires_python>=3.8
licenseMIT License
keywords aiobotocore iotsitewise type-annotations botocore mypy typeshed autocomplete
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <a id="types-aiobotocore-iotsitewise"></a>

# types-aiobotocore-iotsitewise

[![PyPI - types-aiobotocore-iotsitewise](https://img.shields.io/pypi/v/types-aiobotocore-iotsitewise.svg?color=blue)](https://pypi.org/project/types-aiobotocore-iotsitewise)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-aiobotocore-iotsitewise.svg?color=blue)](https://pypi.org/project/types-aiobotocore-iotsitewise)
[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue)](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/)
[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-iotsitewise)](https://pepy.tech/project/types-aiobotocore-iotsitewise)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations for
[aiobotocore.IoTSiteWise 2.12.0](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.23.2](https://github.com/youtype/mypy_boto3_builder).

More information can be found on
[types-aiobotocore](https://pypi.org/project/types-aiobotocore/) page and in
[types-aiobotocore-iotsitewise docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/).

See how it helps to find and fix potential bugs:

![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)

- [types-aiobotocore-iotsitewise](#types-aiobotocore-iotsitewise)
  - [How to install](#how-to-install)
    - [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)
    - [Type definitions](#type-definitions)
  - [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="from-pypi-with-pip"></a>

### From PyPI with pip

Install `types-aiobotocore` for `IoTSiteWise` service.

```bash
# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[iotsitewise]'


# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[iotsitewise]'


# standalone installation
python -m pip install types-aiobotocore-iotsitewise
```

<a id="how-to-uninstall"></a>

## How to uninstall

```bash
python -m pip uninstall -y types-aiobotocore-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 `types-aiobotocore[iotsitewise]` in your environment:

```bash
python -m pip install 'types-aiobotocore[iotsitewise]'
```

Both type checking and code completion should now work. No explicit type
annotations required, write your `aiobotocore` code as usual.

<a id="pycharm"></a>

### PyCharm

Install `types-aiobotocore-lite[iotsitewise]` in your environment:

```bash
python -m pip install 'types-aiobotocore-lite[iotsitewise]'`
```

Both type checking and code completion should now work. Explicit type
annotations **are required**.

Use `types-aiobotocore` package instead for implicit type discovery.

<a id="emacs"></a>

### Emacs

- Install `types-aiobotocore` with services you use in your environment:

```bash
python -m pip install 'types-aiobotocore[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
  `types-aiobotocore`

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="sublime-text"></a>

### Sublime Text

- Install `types-aiobotocore[iotsitewise]` with services you use in your
  environment:

```bash
python -m pip install 'types-aiobotocore[iotsitewise]'
```

- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` 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 `types-aiobotocore[iotsitewise]` in your environment:

```bash
python -m pip install 'types-aiobotocore[iotsitewise]'`
```

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="pyright"></a>

### pyright

- Install `pyright`: `npm i -g pyright`
- Install `types-aiobotocore[iotsitewise]` in your environment:

```bash
python -m pip install 'types-aiobotocore[iotsitewise]'
```

Optionally, you can install `types-aiobotocore` to `typings` folder.

Type checking should now work. No explicit type annotations required, write
your `aiobotocore` code as usual.

<a id="explicit-type-annotations"></a>

## Explicit type annotations

<a id="client-annotations"></a>

### Client annotations

`IoTSiteWiseClient` provides annotations for
`session.create_client("iotsitewise")`.

```python
from aiobotocore.session import get_session

from types_aiobotocore_iotsitewise import IoTSiteWiseClient

session = get_session()
async with session.create_client("iotsitewise") as client:
    client: IoTSiteWiseClient
    # now client usage is checked by mypy and IDE should provide code completion
```

<a id="paginators-annotations"></a>

### Paginators annotations

`types_aiobotocore_iotsitewise.paginator` module contains type annotations for
all paginators.

```python
from aiobotocore.session import get_session

from types_aiobotocore_iotsitewise import IoTSiteWiseClient
from types_aiobotocore_iotsitewise.paginator import (
    ExecuteQueryPaginator,
    GetAssetPropertyAggregatesPaginator,
    GetAssetPropertyValueHistoryPaginator,
    GetInterpolatedAssetPropertyValuesPaginator,
    ListAccessPoliciesPaginator,
    ListActionsPaginator,
    ListAssetModelCompositeModelsPaginator,
    ListAssetModelPropertiesPaginator,
    ListAssetModelsPaginator,
    ListAssetPropertiesPaginator,
    ListAssetRelationshipsPaginator,
    ListAssetsPaginator,
    ListAssociatedAssetsPaginator,
    ListBulkImportJobsPaginator,
    ListCompositionRelationshipsPaginator,
    ListDashboardsPaginator,
    ListGatewaysPaginator,
    ListPortalsPaginator,
    ListProjectAssetsPaginator,
    ListProjectsPaginator,
    ListTimeSeriesPaginator,
)

session = get_session()
async with session.create_client("iotsitewise") as client:
    client: IoTSiteWiseClient

    # Explicit type annotations are optional here
    # Types should be correctly discovered by mypy and IDEs
    execute_query_paginator: ExecuteQueryPaginator = client.get_paginator("execute_query")
    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_actions_paginator: ListActionsPaginator = client.get_paginator("list_actions")
    list_asset_model_composite_models_paginator: ListAssetModelCompositeModelsPaginator = (
        client.get_paginator("list_asset_model_composite_models")
    )
    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_composition_relationships_paginator: ListCompositionRelationshipsPaginator = (
        client.get_paginator("list_composition_relationships")
    )
    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

`types_aiobotocore_iotsitewise.waiter` module contains type annotations for all
waiters.

```python
from aiobotocore.session import get_session

from types_aiobotocore_iotsitewise.client import IoTSiteWiseClient
from types_aiobotocore_iotsitewise.waiter import (
    AssetActiveWaiter,
    AssetModelActiveWaiter,
    AssetModelNotExistsWaiter,
    AssetNotExistsWaiter,
    PortalActiveWaiter,
    PortalNotExistsWaiter,
)

session = get_session()
async with session.create_client("iotsitewise") as client:
    client: IoTSiteWiseClient

    # 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

`types_aiobotocore_iotsitewise.literals` module contains literals extracted
from shapes that can be used in user code for type checking.

Full list of `IoTSiteWise` Literals can be found in
[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/literals/).

```python
from types_aiobotocore_iotsitewise.literals import AggregateTypeType


def check_value(value: AggregateTypeType) -> bool: ...
```

<a id="type-definitions"></a>

### Type definitions

`types_aiobotocore_iotsitewise.type_defs` module contains structures and shapes
assembled to typed dictionaries and unions for additional type checking.

Full list of `IoTSiteWise` TypeDefs can be found in
[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/type_defs/).

```python
from types_aiobotocore_iotsitewise.type_defs import ActionDefinitionTypeDef


def get_value() -> ActionDefinitionTypeDef:
    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
`aiobotocore` updates. It delivers drop-in type annotations for you and makes
sure that:

- All available `aiobotocore` services are covered.
- Each public class and method of every `aiobotocore` service gets valid type
  annotations extracted from `botocore` schemas.
- 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`, `aiobotocore` and `aioboto3`
  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.resource` calls
- Auto discovery of types for `session.client` and `session.resource` 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

`types-aiobotocore-iotsitewise` version is the same as related `aiobotocore`
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
[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_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.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/youtype/mypy_boto3_builder",
    "name": "types-aiobotocore-iotsitewise",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "aiobotocore iotsitewise type-annotations botocore mypy typeshed autocomplete",
    "author": "Vlad Emelianov",
    "author_email": "vlad.emelianov.nz@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e6/10/83383eda3ac070b06759091113f6ce5fee220687c603d8c61daf949e8814/types-aiobotocore-iotsitewise-2.12.0.tar.gz",
    "platform": null,
    "description": "<a id=\"types-aiobotocore-iotsitewise\"></a>\n\n# types-aiobotocore-iotsitewise\n\n[![PyPI - types-aiobotocore-iotsitewise](https://img.shields.io/pypi/v/types-aiobotocore-iotsitewise.svg?color=blue)](https://pypi.org/project/types-aiobotocore-iotsitewise)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-aiobotocore-iotsitewise.svg?color=blue)](https://pypi.org/project/types-aiobotocore-iotsitewise)\n[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue)](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore-iotsitewise)](https://pepy.tech/project/types-aiobotocore-iotsitewise)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations for\n[aiobotocore.IoTSiteWise 2.12.0](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/iotsitewise.html#IoTSiteWise)\nservice compatible with [VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright) and other tools.\n\nGenerated by\n[mypy-boto3-builder 7.23.2](https://github.com/youtype/mypy_boto3_builder).\n\nMore information can be found on\n[types-aiobotocore](https://pypi.org/project/types-aiobotocore/) page and in\n[types-aiobotocore-iotsitewise docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/).\n\nSee how it helps to find and fix potential bugs:\n\n![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif)\n\n- [types-aiobotocore-iotsitewise](#types-aiobotocore-iotsitewise)\n  - [How to install](#how-to-install)\n    - [From PyPI with pip](#from-pypi-with-pip)\n  - [How to uninstall](#how-to-uninstall)\n  - [Usage](#usage)\n    - [VSCode](#vscode)\n    - [PyCharm](#pycharm)\n    - [Emacs](#emacs)\n    - [Sublime Text](#sublime-text)\n    - [Other IDEs](#other-ides)\n    - [mypy](#mypy)\n    - [pyright](#pyright)\n  - [Explicit type annotations](#explicit-type-annotations)\n    - [Client annotations](#client-annotations)\n    - [Paginators annotations](#paginators-annotations)\n    - [Waiters annotations](#waiters-annotations)\n    - [Literals](#literals)\n    - [Type definitions](#type-definitions)\n  - [How it works](#how-it-works)\n  - [What's new](#what's-new)\n    - [Implemented features](#implemented-features)\n    - [Latest changes](#latest-changes)\n  - [Versioning](#versioning)\n  - [Thank you](#thank-you)\n  - [Documentation](#documentation)\n  - [Support and contributing](#support-and-contributing)\n\n<a id=\"how-to-install\"></a>\n\n## How to install\n\n<a id=\"from-pypi-with-pip\"></a>\n\n### From PyPI with pip\n\nInstall `types-aiobotocore` for `IoTSiteWise` service.\n\n```bash\n# install with aiobotocore type annotations\npython -m pip install 'types-aiobotocore[iotsitewise]'\n\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'types-aiobotocore-lite[iotsitewise]'\n\n\n# standalone installation\npython -m pip install types-aiobotocore-iotsitewise\n```\n\n<a id=\"how-to-uninstall\"></a>\n\n## How to uninstall\n\n```bash\npython -m pip uninstall -y types-aiobotocore-iotsitewise\n```\n\n<a id=\"usage\"></a>\n\n## Usage\n\n<a id=\"vscode\"></a>\n\n### VSCode\n\n- Install\n  [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install\n  [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `types-aiobotocore[iotsitewise]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[iotsitewise]'\n```\n\nBoth type checking and code completion should now work. No explicit type\nannotations required, write your `aiobotocore` code as usual.\n\n<a id=\"pycharm\"></a>\n\n### PyCharm\n\nInstall `types-aiobotocore-lite[iotsitewise]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore-lite[iotsitewise]'`\n```\n\nBoth type checking and code completion should now work. Explicit type\nannotations **are required**.\n\nUse `types-aiobotocore` package instead for implicit type discovery.\n\n<a id=\"emacs\"></a>\n\n### Emacs\n\n- Install `types-aiobotocore` with services you use in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[iotsitewise]'\n```\n\n- Install [use-package](https://github.com/jwiegley/use-package),\n  [lsp](https://github.com/emacs-lsp/lsp-mode/),\n  [company](https://github.com/company-mode/company-mode) and\n  [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n  :ensure t\n  :hook (python-mode . (lambda ()\n                          (require 'lsp-pyright)\n                          (lsp)))  ; or lsp-deferred\n  :init (when (executable-find \"python3\")\n          (setq lsp-pyright-python-executable-cmd \"python3\"))\n  )\n```\n\n- Make sure emacs uses the environment where you have installed\n  `types-aiobotocore`\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"sublime-text\"></a>\n\n### Sublime Text\n\n- Install `types-aiobotocore[iotsitewise]` with services you use in your\n  environment:\n\n```bash\npython -m pip install 'types-aiobotocore[iotsitewise]'\n```\n\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"other-ides\"></a>\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything\nshould work.\n\n<a id=\"mypy\"></a>\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `types-aiobotocore[iotsitewise]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[iotsitewise]'`\n```\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"pyright\"></a>\n\n### pyright\n\n- Install `pyright`: `npm i -g pyright`\n- Install `types-aiobotocore[iotsitewise]` in your environment:\n\n```bash\npython -m pip install 'types-aiobotocore[iotsitewise]'\n```\n\nOptionally, you can install `types-aiobotocore` to `typings` folder.\n\nType checking should now work. No explicit type annotations required, write\nyour `aiobotocore` code as usual.\n\n<a id=\"explicit-type-annotations\"></a>\n\n## Explicit type annotations\n\n<a id=\"client-annotations\"></a>\n\n### Client annotations\n\n`IoTSiteWiseClient` provides annotations for\n`session.create_client(\"iotsitewise\")`.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_iotsitewise import IoTSiteWiseClient\n\nsession = get_session()\nasync with session.create_client(\"iotsitewise\") as client:\n    client: IoTSiteWiseClient\n    # now client usage is checked by mypy and IDE should provide code completion\n```\n\n<a id=\"paginators-annotations\"></a>\n\n### Paginators annotations\n\n`types_aiobotocore_iotsitewise.paginator` module contains type annotations for\nall paginators.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_iotsitewise import IoTSiteWiseClient\nfrom types_aiobotocore_iotsitewise.paginator import (\n    ExecuteQueryPaginator,\n    GetAssetPropertyAggregatesPaginator,\n    GetAssetPropertyValueHistoryPaginator,\n    GetInterpolatedAssetPropertyValuesPaginator,\n    ListAccessPoliciesPaginator,\n    ListActionsPaginator,\n    ListAssetModelCompositeModelsPaginator,\n    ListAssetModelPropertiesPaginator,\n    ListAssetModelsPaginator,\n    ListAssetPropertiesPaginator,\n    ListAssetRelationshipsPaginator,\n    ListAssetsPaginator,\n    ListAssociatedAssetsPaginator,\n    ListBulkImportJobsPaginator,\n    ListCompositionRelationshipsPaginator,\n    ListDashboardsPaginator,\n    ListGatewaysPaginator,\n    ListPortalsPaginator,\n    ListProjectAssetsPaginator,\n    ListProjectsPaginator,\n    ListTimeSeriesPaginator,\n)\n\nsession = get_session()\nasync with session.create_client(\"iotsitewise\") as client:\n    client: IoTSiteWiseClient\n\n    # Explicit type annotations are optional here\n    # Types should be correctly discovered by mypy and IDEs\n    execute_query_paginator: ExecuteQueryPaginator = client.get_paginator(\"execute_query\")\n    get_asset_property_aggregates_paginator: GetAssetPropertyAggregatesPaginator = (\n        client.get_paginator(\"get_asset_property_aggregates\")\n    )\n    get_asset_property_value_history_paginator: GetAssetPropertyValueHistoryPaginator = (\n        client.get_paginator(\"get_asset_property_value_history\")\n    )\n    get_interpolated_asset_property_values_paginator: (\n        GetInterpolatedAssetPropertyValuesPaginator\n    ) = client.get_paginator(\"get_interpolated_asset_property_values\")\n    list_access_policies_paginator: ListAccessPoliciesPaginator = client.get_paginator(\n        \"list_access_policies\"\n    )\n    list_actions_paginator: ListActionsPaginator = client.get_paginator(\"list_actions\")\n    list_asset_model_composite_models_paginator: ListAssetModelCompositeModelsPaginator = (\n        client.get_paginator(\"list_asset_model_composite_models\")\n    )\n    list_asset_model_properties_paginator: ListAssetModelPropertiesPaginator = client.get_paginator(\n        \"list_asset_model_properties\"\n    )\n    list_asset_models_paginator: ListAssetModelsPaginator = client.get_paginator(\n        \"list_asset_models\"\n    )\n    list_asset_properties_paginator: ListAssetPropertiesPaginator = client.get_paginator(\n        \"list_asset_properties\"\n    )\n    list_asset_relationships_paginator: ListAssetRelationshipsPaginator = client.get_paginator(\n        \"list_asset_relationships\"\n    )\n    list_assets_paginator: ListAssetsPaginator = client.get_paginator(\"list_assets\")\n    list_associated_assets_paginator: ListAssociatedAssetsPaginator = client.get_paginator(\n        \"list_associated_assets\"\n    )\n    list_bulk_import_jobs_paginator: ListBulkImportJobsPaginator = client.get_paginator(\n        \"list_bulk_import_jobs\"\n    )\n    list_composition_relationships_paginator: ListCompositionRelationshipsPaginator = (\n        client.get_paginator(\"list_composition_relationships\")\n    )\n    list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator(\"list_dashboards\")\n    list_gateways_paginator: ListGatewaysPaginator = client.get_paginator(\"list_gateways\")\n    list_portals_paginator: ListPortalsPaginator = client.get_paginator(\"list_portals\")\n    list_project_assets_paginator: ListProjectAssetsPaginator = client.get_paginator(\n        \"list_project_assets\"\n    )\n    list_projects_paginator: ListProjectsPaginator = client.get_paginator(\"list_projects\")\n    list_time_series_paginator: ListTimeSeriesPaginator = client.get_paginator(\"list_time_series\")\n```\n\n<a id=\"waiters-annotations\"></a>\n\n### Waiters annotations\n\n`types_aiobotocore_iotsitewise.waiter` module contains type annotations for all\nwaiters.\n\n```python\nfrom aiobotocore.session import get_session\n\nfrom types_aiobotocore_iotsitewise.client import IoTSiteWiseClient\nfrom types_aiobotocore_iotsitewise.waiter import (\n    AssetActiveWaiter,\n    AssetModelActiveWaiter,\n    AssetModelNotExistsWaiter,\n    AssetNotExistsWaiter,\n    PortalActiveWaiter,\n    PortalNotExistsWaiter,\n)\n\nsession = get_session()\nasync with session.create_client(\"iotsitewise\") as client:\n    client: IoTSiteWiseClient\n\n    # Explicit type annotations are optional here\n    # Types should be correctly discovered by mypy and IDEs\n    asset_active_waiter: AssetActiveWaiter = client.get_waiter(\"asset_active\")\n    asset_model_active_waiter: AssetModelActiveWaiter = client.get_waiter(\"asset_model_active\")\n    asset_model_not_exists_waiter: AssetModelNotExistsWaiter = client.get_waiter(\n        \"asset_model_not_exists\"\n    )\n    asset_not_exists_waiter: AssetNotExistsWaiter = client.get_waiter(\"asset_not_exists\")\n    portal_active_waiter: PortalActiveWaiter = client.get_waiter(\"portal_active\")\n    portal_not_exists_waiter: PortalNotExistsWaiter = client.get_waiter(\"portal_not_exists\")\n```\n\n<a id=\"literals\"></a>\n\n### Literals\n\n`types_aiobotocore_iotsitewise.literals` module contains literals extracted\nfrom shapes that can be used in user code for type checking.\n\nFull list of `IoTSiteWise` Literals can be found in\n[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/literals/).\n\n```python\nfrom types_aiobotocore_iotsitewise.literals import AggregateTypeType\n\n\ndef check_value(value: AggregateTypeType) -> bool: ...\n```\n\n<a id=\"type-definitions\"></a>\n\n### Type definitions\n\n`types_aiobotocore_iotsitewise.type_defs` module contains structures and shapes\nassembled to typed dictionaries and unions for additional type checking.\n\nFull list of `IoTSiteWise` TypeDefs can be found in\n[docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/type_defs/).\n\n```python\nfrom types_aiobotocore_iotsitewise.type_defs import ActionDefinitionTypeDef\n\n\ndef get_value() -> ActionDefinitionTypeDef:\n    return {...}\n```\n\n<a id=\"how-it-works\"></a>\n\n## How it works\n\nFully automated\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully\ngenerates type annotations for each service, patiently waiting for\n`aiobotocore` updates. It delivers drop-in type annotations for you and makes\nsure that:\n\n- All available `aiobotocore` services are covered.\n- Each public class and method of every `aiobotocore` service gets valid type\n  annotations extracted from `botocore` schemas.\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black) and\n  [isort](https://github.com/PyCQA/isort) for readability.\n\n<a id=\"what's-new\"></a>\n\n## What's new\n\n<a id=\"implemented-features\"></a>\n\n### Implemented features\n\n- Fully type annotated `boto3`, `botocore`, `aiobotocore` and `aioboto3`\n  libraries\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs`\n  compatibility\n- `Client`, `ServiceResource`, `Resource`, `Waiter` `Paginator` type\n  annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.resource` calls\n- Auto discovery of types for `session.client` and `session.resource` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator`\n  calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n- Auto discovery of types for `aiobotocore.Session.create_client` calls\n\n<a id=\"latest-changes\"></a>\n\n### Latest changes\n\nBuilder changelog can be found in\n[Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n<a id=\"versioning\"></a>\n\n## Versioning\n\n`types-aiobotocore-iotsitewise` version is the same as related `aiobotocore`\nversion and follows [PEP 440](https://www.python.org/dev/peps/pep-0440/)\nformat.\n\n<a id=\"thank-you\"></a>\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n  [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n  this package is based on top of his work\n- [black](https://github.com/psf/black) developers for an awesome formatting\n  tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n  [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work\n  for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed\n  Python\n\n<a id=\"documentation\"></a>\n\n## Documentation\n\nAll services type annotations can be found in\n[aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/)\n\n<a id=\"support-and-contributing\"></a>\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features\nin [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/)\nrepository.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Type annotations for aiobotocore.IoTSiteWise 2.12.0 service generated with mypy-boto3-builder 7.23.2",
    "version": "2.12.0",
    "project_urls": {
        "Documentation": "https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_iotsitewise/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Source": "https://github.com/youtype/mypy_boto3_builder",
        "Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
    },
    "split_keywords": [
        "aiobotocore",
        "iotsitewise",
        "type-annotations",
        "botocore",
        "mypy",
        "typeshed",
        "autocomplete"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5db49f2122ee6a2d01408f2c465c34921565e45ac6c45cd7115da20175bf94a9",
                "md5": "0c138776d9adbb69ef225078dc7e123e",
                "sha256": "b9ebdfa5bc3996b8b6a8daf91c96a717b69817adac33668334d141b67d2bbed4"
            },
            "downloads": -1,
            "filename": "types_aiobotocore_iotsitewise-2.12.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0c138776d9adbb69ef225078dc7e123e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 60193,
            "upload_time": "2024-02-29T01:36:23",
            "upload_time_iso_8601": "2024-02-29T01:36:23.001860Z",
            "url": "https://files.pythonhosted.org/packages/5d/b4/9f2122ee6a2d01408f2c465c34921565e45ac6c45cd7115da20175bf94a9/types_aiobotocore_iotsitewise-2.12.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e61083383eda3ac070b06759091113f6ce5fee220687c603d8c61daf949e8814",
                "md5": "b9b82ab95edd6c6eac8e5e7c74b19a12",
                "sha256": "fea5e95deb020138a2d76d57685b88679a91cbec6f68ab54fad59fd7f26038cc"
            },
            "downloads": -1,
            "filename": "types-aiobotocore-iotsitewise-2.12.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b9b82ab95edd6c6eac8e5e7c74b19a12",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 51180,
            "upload_time": "2024-02-29T01:36:32",
            "upload_time_iso_8601": "2024-02-29T01:36:32.007793Z",
            "url": "https://files.pythonhosted.org/packages/e6/10/83383eda3ac070b06759091113f6ce5fee220687c603d8c61daf949e8814/types-aiobotocore-iotsitewise-2.12.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-29 01:36:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "types-aiobotocore-iotsitewise"
}
        
Elapsed time: 0.19828s