# packages

pkgId: 38ce9b0e7b19e39c757dd6d2720e1065fad87e7a66b3a90da16b8bd3d66ec0f1
name: python-types-aiobotocore-sts-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-sts
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-sts-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-sts-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-sts"></a>



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

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

  Type annotations for
  [aiobotocore STS 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-sts docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sts/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-sts](#types-aiobotocore-sts)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `STS` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[sts]'



  python -m pip install 'types-aiobotocore-lite[sts]'


  python -m pip install types-aiobotocore-sts
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-sts
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[sts]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[sts]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[sts]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-sts` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `STSClient` provides annotations for `session.create_client("sts")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_sts import STSClient

  session = get_session()
  async with session.create_client("sts") as client:
      client: STSClient
      
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_sts.literals import STSServiceName


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

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



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

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

  ```python
  from types_aiobotocore_sts.type_defs import PolicyDescriptorTypeTypeDef


  def get_value() -> PolicyDescriptorTypeTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-sts` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_sts/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 4b95e74d4e50dc67905c7bedf0c63ae21b83bc966f58e9fc088a218d21e7d451
name: python-types-aiobotocore-tnb-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-tnb
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-tnb-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-tnb-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-tnb"></a>



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

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

  Type annotations for
  [aiobotocore TelcoNetworkBuilder 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-tnb docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_tnb/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-tnb](#types-aiobotocore-tnb)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `TelcoNetworkBuilder` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[tnb]'



  python -m pip install 'types-aiobotocore-lite[tnb]'


  python -m pip install types-aiobotocore-tnb
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-tnb
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[tnb]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[tnb]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[tnb]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-tnb` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `TelcoNetworkBuilderClient` provides annotations for
  `session.create_client("tnb")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_tnb import TelcoNetworkBuilderClient

  session = get_session()
  async with session.create_client("tnb") as client:
      client: TelcoNetworkBuilderClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_tnb import TelcoNetworkBuilderClient
  from types_aiobotocore_tnb.paginator import (
      ListSolFunctionInstancesPaginator,
      ListSolFunctionPackagesPaginator,
      ListSolNetworkInstancesPaginator,
      ListSolNetworkOperationsPaginator,
      ListSolNetworkPackagesPaginator,
  )

  session = get_session()
  async with session.create_client("tnb") as client:
      client: TelcoNetworkBuilderClient

      
      
      list_sol_function_instances_paginator: ListSolFunctionInstancesPaginator = client.get_paginator(
          "list_sol_function_instances"
      )
      list_sol_function_packages_paginator: ListSolFunctionPackagesPaginator = client.get_paginator(
          "list_sol_function_packages"
      )
      list_sol_network_instances_paginator: ListSolNetworkInstancesPaginator = client.get_paginator(
          "list_sol_network_instances"
      )
      list_sol_network_operations_paginator: ListSolNetworkOperationsPaginator = client.get_paginator(
          "list_sol_network_operations"
      )
      list_sol_network_packages_paginator: ListSolNetworkPackagesPaginator = client.get_paginator(
          "list_sol_network_packages"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_tnb.literals import DescriptorContentTypeType


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

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



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

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

  ```python
  from types_aiobotocore_tnb.type_defs import BlobTypeDef


  def get_value() -> BlobTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-tnb` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_tnb/)

  <a id="support-and-contributing"></a>



  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.


pkgId: ef88daa05e400191b6f0512a15cc65c8a39fc24465e868f0401d56d0749915d6
name: python-types-aiobotocore-transcribe-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-transcribe
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-transcribe-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-transcribe-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-transcribe"></a>



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

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

  Type annotations for
  [aiobotocore TranscribeService 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-transcribe docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_transcribe/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-transcribe](#types-aiobotocore-transcribe)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `TranscribeService` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[transcribe]'



  python -m pip install 'types-aiobotocore-lite[transcribe]'


  python -m pip install types-aiobotocore-transcribe
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-transcribe
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[transcribe]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[transcribe]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[transcribe]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-transcribe` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `TranscribeServiceClient` provides annotations for
  `session.create_client("transcribe")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_transcribe import TranscribeServiceClient

  session = get_session()
  async with session.create_client("transcribe") as client:
      client: TranscribeServiceClient
      
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_transcribe.literals import BaseModelNameType


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

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



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

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

  ```python
  from types_aiobotocore_transcribe.type_defs import AbsoluteTimeRangeTypeDef


  def get_value() -> AbsoluteTimeRangeTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-transcribe` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_transcribe/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 77b5d96452f3b2282938827a2353ee1b9bb3a27f07ef0a56861833b1d82db312
name: python-types-aiobotocore-transfer-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-transfer
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-transfer-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-transfer-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-transfer"></a>



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

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

  Type annotations for
  [aiobotocore Transfer 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-transfer docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_transfer/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-transfer](#types-aiobotocore-transfer)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `Transfer` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[transfer]'



  python -m pip install 'types-aiobotocore-lite[transfer]'


  python -m pip install types-aiobotocore-transfer
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-transfer
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[transfer]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[transfer]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[transfer]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-transfer` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `TransferClient` provides annotations for `session.create_client("transfer")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_transfer import TransferClient

  session = get_session()
  async with session.create_client("transfer") as client:
      client: TransferClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_transfer import TransferClient
  from types_aiobotocore_transfer.paginator import (
      ListAccessesPaginator,
      ListAgreementsPaginator,
      ListCertificatesPaginator,
      ListConnectorsPaginator,
      ListExecutionsPaginator,
      ListFileTransferResultsPaginator,
      ListProfilesPaginator,
      ListSecurityPoliciesPaginator,
      ListServersPaginator,
      ListTagsForResourcePaginator,
      ListUsersPaginator,
      ListWebAppsPaginator,
      ListWorkflowsPaginator,
  )

  session = get_session()
  async with session.create_client("transfer") as client:
      client: TransferClient

      
      
      list_accesses_paginator: ListAccessesPaginator = client.get_paginator("list_accesses")
      list_agreements_paginator: ListAgreementsPaginator = client.get_paginator("list_agreements")
      list_certificates_paginator: ListCertificatesPaginator = client.get_paginator(
          "list_certificates"
      )
      list_connectors_paginator: ListConnectorsPaginator = client.get_paginator("list_connectors")
      list_executions_paginator: ListExecutionsPaginator = client.get_paginator("list_executions")
      list_file_transfer_results_paginator: ListFileTransferResultsPaginator = client.get_paginator(
          "list_file_transfer_results"
      )
      list_profiles_paginator: ListProfilesPaginator = client.get_paginator("list_profiles")
      list_security_policies_paginator: ListSecurityPoliciesPaginator = client.get_paginator(
          "list_security_policies"
      )
      list_servers_paginator: ListServersPaginator = client.get_paginator("list_servers")
      list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
          "list_tags_for_resource"
      )
      list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
      list_web_apps_paginator: ListWebAppsPaginator = client.get_paginator("list_web_apps")
      list_workflows_paginator: ListWorkflowsPaginator = client.get_paginator("list_workflows")
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_transfer.client import TransferClient
  from types_aiobotocore_transfer.waiter import ServerOfflineWaiter, ServerOnlineWaiter

  session = get_session()
  async with session.create_client("transfer") as client:
      client: TransferClient

      
      
      server_offline_waiter: ServerOfflineWaiter = client.get_waiter("server_offline")
      server_online_waiter: ServerOnlineWaiter = client.get_waiter("server_online")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_transfer.literals import AgreementStatusTypeType


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

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



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

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

  ```python
  from types_aiobotocore_transfer.type_defs import As2ConnectorConfigTypeDef


  def get_value() -> As2ConnectorConfigTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-transfer` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_transfer/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 9bd4413fc6e453d9a8132888f3291553369e621329074c0b7258fc00c47f2d6c
name: python-types-aiobotocore-translate-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-translate
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-translate-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-translate-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-translate"></a>



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

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

  Type annotations for
  [aiobotocore Translate 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-translate docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_translate/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-translate](#types-aiobotocore-translate)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `Translate` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[translate]'



  python -m pip install 'types-aiobotocore-lite[translate]'


  python -m pip install types-aiobotocore-translate
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-translate
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[translate]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[translate]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[translate]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-translate` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `TranslateClient` provides annotations for
  `session.create_client("translate")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_translate import TranslateClient

  session = get_session()
  async with session.create_client("translate") as client:
      client: TranslateClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_translate import TranslateClient
  from types_aiobotocore_translate.paginator import ListTerminologiesPaginator

  session = get_session()
  async with session.create_client("translate") as client:
      client: TranslateClient

      
      
      list_terminologies_paginator: ListTerminologiesPaginator = client.get_paginator(
          "list_terminologies"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_translate.literals import BrevityType


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

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



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

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

  ```python
  from types_aiobotocore_translate.type_defs import TermTypeDef


  def get_value() -> TermTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-translate` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_translate/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 2867447d9ae84e086f4825a90b7ede6902af4544b8d90ad5371f1bfaed569168
name: python-types-aiobotocore-trustedadvisor-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-trustedadvisor
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-trustedadvisor-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-trustedadvisor-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-trustedadvisor"></a>



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

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

  Type annotations for
  [aiobotocore TrustedAdvisorPublicAPI 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-trustedadvisor docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_trustedadvisor/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-trustedadvisor](#types-aiobotocore-trustedadvisor)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `TrustedAdvisorPublicAPI` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[trustedadvisor]'



  python -m pip install 'types-aiobotocore-lite[trustedadvisor]'


  python -m pip install types-aiobotocore-trustedadvisor
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-trustedadvisor
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[trustedadvisor]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[trustedadvisor]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[trustedadvisor]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-trustedadvisor` dependency in production. However, there is
  an issue in `pylint` that it complains about undefined variables. To fix it,
  set all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `TrustedAdvisorPublicAPIClient` provides annotations for
  `session.create_client("trustedadvisor")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_trustedadvisor import TrustedAdvisorPublicAPIClient

  session = get_session()
  async with session.create_client("trustedadvisor") as client:
      client: TrustedAdvisorPublicAPIClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_trustedadvisor import TrustedAdvisorPublicAPIClient
  from types_aiobotocore_trustedadvisor.paginator import (
      ListChecksPaginator,
      ListOrganizationRecommendationAccountsPaginator,
      ListOrganizationRecommendationResourcesPaginator,
      ListOrganizationRecommendationsPaginator,
      ListRecommendationResourcesPaginator,
      ListRecommendationsPaginator,
  )

  session = get_session()
  async with session.create_client("trustedadvisor") as client:
      client: TrustedAdvisorPublicAPIClient

      
      
      list_checks_paginator: ListChecksPaginator = client.get_paginator("list_checks")
      list_organization_recommendation_accounts_paginator: ListOrganizationRecommendationAccountsPaginator = client.get_paginator(
          "list_organization_recommendation_accounts"
      )
      list_organization_recommendation_resources_paginator: ListOrganizationRecommendationResourcesPaginator = client.get_paginator(
          "list_organization_recommendation_resources"
      )
      list_organization_recommendations_paginator: ListOrganizationRecommendationsPaginator = (
          client.get_paginator("list_organization_recommendations")
      )
      list_recommendation_resources_paginator: ListRecommendationResourcesPaginator = (
          client.get_paginator("list_recommendation_resources")
      )
      list_recommendations_paginator: ListRecommendationsPaginator = client.get_paginator(
          "list_recommendations"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_trustedadvisor.literals import ExclusionStatusType


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

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



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

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

  ```python
  from types_aiobotocore_trustedadvisor.type_defs import AccountRecommendationLifecycleSummaryTypeDef


  def get_value() -> AccountRecommendationLifecycleSummaryTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-trustedadvisor` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_trustedadvisor/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 1671d544dddd89b4d4168e874094f455a189cc6bc99c12678962389e38e52d76
name: python-types-aiobotocore-verifiedpermissions-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-verifiedpermissions
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-verifiedpermissions-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-verifiedpermissions-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-verifiedpermissions"></a>



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

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

  Type annotations for
  [aiobotocore VerifiedPermissions 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-verifiedpermissions docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_verifiedpermissions/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-verifiedpermissions](#types-aiobotocore-verifiedpermissions)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `VerifiedPermissions` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[verifiedpermissions]'



  python -m pip install 'types-aiobotocore-lite[verifiedpermissions]'


  python -m pip install types-aiobotocore-verifiedpermissions
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-verifiedpermissions
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[verifiedpermissions]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[verifiedpermissions]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[verifiedpermissions]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-verifiedpermissions` dependency in production. However,
  there is an issue in `pylint` that it complains about undefined variables. To
  fix it, set all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `VerifiedPermissionsClient` provides annotations for
  `session.create_client("verifiedpermissions")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_verifiedpermissions import VerifiedPermissionsClient

  session = get_session()
  async with session.create_client("verifiedpermissions") as client:
      client: VerifiedPermissionsClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_verifiedpermissions import VerifiedPermissionsClient
  from types_aiobotocore_verifiedpermissions.paginator import (
      ListIdentitySourcesPaginator,
      ListPoliciesPaginator,
      ListPolicyStoresPaginator,
      ListPolicyTemplatesPaginator,
  )

  session = get_session()
  async with session.create_client("verifiedpermissions") as client:
      client: VerifiedPermissionsClient

      
      
      list_identity_sources_paginator: ListIdentitySourcesPaginator = client.get_paginator(
          "list_identity_sources"
      )
      list_policies_paginator: ListPoliciesPaginator = client.get_paginator("list_policies")
      list_policy_stores_paginator: ListPolicyStoresPaginator = client.get_paginator(
          "list_policy_stores"
      )
      list_policy_templates_paginator: ListPolicyTemplatesPaginator = client.get_paginator(
          "list_policy_templates"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_verifiedpermissions.literals import BatchGetPolicyErrorCodeType


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

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



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

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

  ```python
  from types_aiobotocore_verifiedpermissions.type_defs import ActionIdentifierTypeDef


  def get_value() -> ActionIdentifierTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-verifiedpermissions` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_verifiedpermissions/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 9b5361f6e47547c21cb9adb9308228f5faf9a6c3156c17a6b1bb4ad847712ea6
name: python-types-aiobotocore-voice-id-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-voice-id
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-voice-id-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-voice-id-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-voice-id"></a>



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

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

  Type annotations for
  [aiobotocore VoiceID 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-voice-id docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_voice_id/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-voice-id](#types-aiobotocore-voice-id)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `VoiceID` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[voice-id]'



  python -m pip install 'types-aiobotocore-lite[voice-id]'


  python -m pip install types-aiobotocore-voice-id
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-voice-id
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[voice-id]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[voice-id]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[voice-id]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-voice-id` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `VoiceIDClient` provides annotations for `session.create_client("voice-id")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_voice_id import VoiceIDClient

  session = get_session()
  async with session.create_client("voice-id") as client:
      client: VoiceIDClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_voice_id import VoiceIDClient
  from types_aiobotocore_voice_id.paginator import (
      ListDomainsPaginator,
      ListFraudsterRegistrationJobsPaginator,
      ListFraudstersPaginator,
      ListSpeakerEnrollmentJobsPaginator,
      ListSpeakersPaginator,
      ListWatchlistsPaginator,
  )

  session = get_session()
  async with session.create_client("voice-id") as client:
      client: VoiceIDClient

      
      
      list_domains_paginator: ListDomainsPaginator = client.get_paginator("list_domains")
      list_fraudster_registration_jobs_paginator: ListFraudsterRegistrationJobsPaginator = (
          client.get_paginator("list_fraudster_registration_jobs")
      )
      list_fraudsters_paginator: ListFraudstersPaginator = client.get_paginator("list_fraudsters")
      list_speaker_enrollment_jobs_paginator: ListSpeakerEnrollmentJobsPaginator = (
          client.get_paginator("list_speaker_enrollment_jobs")
      )
      list_speakers_paginator: ListSpeakersPaginator = client.get_paginator("list_speakers")
      list_watchlists_paginator: ListWatchlistsPaginator = client.get_paginator("list_watchlists")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_voice_id.literals import AuthenticationDecisionType


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

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



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

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

  ```python
  from types_aiobotocore_voice_id.type_defs import AssociateFraudsterRequestRequestTypeDef


  def get_value() -> AssociateFraudsterRequestRequestTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-voice-id` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_voice_id/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 11eb0111b4186d7cf9828ca1ff39dd151dd045a6e716430305cad3d27da20447
name: python-types-aiobotocore-vpc-lattice-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-vpc-lattice
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-vpc-lattice-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-vpc-lattice-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-vpc-lattice"></a>



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

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

  Type annotations for
  [aiobotocore VPCLattice 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-vpc-lattice docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_vpc_lattice/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-vpc-lattice](#types-aiobotocore-vpc-lattice)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `VPCLattice` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[vpc-lattice]'



  python -m pip install 'types-aiobotocore-lite[vpc-lattice]'


  python -m pip install types-aiobotocore-vpc-lattice
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-vpc-lattice
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[vpc-lattice]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[vpc-lattice]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[vpc-lattice]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-vpc-lattice` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `VPCLatticeClient` provides annotations for
  `session.create_client("vpc-lattice")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_vpc_lattice import VPCLatticeClient

  session = get_session()
  async with session.create_client("vpc-lattice") as client:
      client: VPCLatticeClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_vpc_lattice import VPCLatticeClient
  from types_aiobotocore_vpc_lattice.paginator import (
      ListAccessLogSubscriptionsPaginator,
      ListListenersPaginator,
      ListResourceConfigurationsPaginator,
      ListResourceEndpointAssociationsPaginator,
      ListResourceGatewaysPaginator,
      ListRulesPaginator,
      ListServiceNetworkResourceAssociationsPaginator,
      ListServiceNetworkServiceAssociationsPaginator,
      ListServiceNetworkVpcAssociationsPaginator,
      ListServiceNetworkVpcEndpointAssociationsPaginator,
      ListServiceNetworksPaginator,
      ListServicesPaginator,
      ListTargetGroupsPaginator,
      ListTargetsPaginator,
  )

  session = get_session()
  async with session.create_client("vpc-lattice") as client:
      client: VPCLatticeClient

      
      
      list_access_log_subscriptions_paginator: ListAccessLogSubscriptionsPaginator = (
          client.get_paginator("list_access_log_subscriptions")
      )
      list_listeners_paginator: ListListenersPaginator = client.get_paginator("list_listeners")
      list_resource_configurations_paginator: ListResourceConfigurationsPaginator = (
          client.get_paginator("list_resource_configurations")
      )
      list_resource_endpoint_associations_paginator: ListResourceEndpointAssociationsPaginator = (
          client.get_paginator("list_resource_endpoint_associations")
      )
      list_resource_gateways_paginator: ListResourceGatewaysPaginator = client.get_paginator(
          "list_resource_gateways"
      )
      list_rules_paginator: ListRulesPaginator = client.get_paginator("list_rules")
      list_service_network_resource_associations_paginator: ListServiceNetworkResourceAssociationsPaginator = client.get_paginator(
          "list_service_network_resource_associations"
      )
      list_service_network_service_associations_paginator: ListServiceNetworkServiceAssociationsPaginator = client.get_paginator(
          "list_service_network_service_associations"
      )
      list_service_network_vpc_associations_paginator: ListServiceNetworkVpcAssociationsPaginator = (
          client.get_paginator("list_service_network_vpc_associations")
      )
      list_service_network_vpc_endpoint_associations_paginator: ListServiceNetworkVpcEndpointAssociationsPaginator = client.get_paginator(
          "list_service_network_vpc_endpoint_associations"
      )
      list_service_networks_paginator: ListServiceNetworksPaginator = client.get_paginator(
          "list_service_networks"
      )
      list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
      list_target_groups_paginator: ListTargetGroupsPaginator = client.get_paginator(
          "list_target_groups"
      )
      list_targets_paginator: ListTargetsPaginator = client.get_paginator("list_targets")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_vpc_lattice.literals import AuthPolicyStateType


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

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



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

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

  ```python
  from types_aiobotocore_vpc_lattice.type_defs import AccessLogSubscriptionSummaryTypeDef


  def get_value() -> AccessLogSubscriptionSummaryTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-vpc-lattice` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_vpc_lattice/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 65b400b764913ef95be6d5d1130b217b63081d728e4960ff8432623e4418be26
name: python-types-aiobotocore-waf-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-waf
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-waf-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-waf-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-waf"></a>



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

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

  Type annotations for
  [aiobotocore WAF 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-waf docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_waf/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-waf](#types-aiobotocore-waf)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WAF` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[waf]'



  python -m pip install 'types-aiobotocore-lite[waf]'


  python -m pip install types-aiobotocore-waf
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-waf
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[waf]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[waf]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[waf]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-waf` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WAFClient` provides annotations for `session.create_client("waf")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_waf import WAFClient

  session = get_session()
  async with session.create_client("waf") as client:
      client: WAFClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_waf import WAFClient
  from types_aiobotocore_waf.paginator import (
      GetRateBasedRuleManagedKeysPaginator,
      ListActivatedRulesInRuleGroupPaginator,
      ListByteMatchSetsPaginator,
      ListGeoMatchSetsPaginator,
      ListIPSetsPaginator,
      ListLoggingConfigurationsPaginator,
      ListRateBasedRulesPaginator,
      ListRegexMatchSetsPaginator,
      ListRegexPatternSetsPaginator,
      ListRuleGroupsPaginator,
      ListRulesPaginator,
      ListSizeConstraintSetsPaginator,
      ListSqlInjectionMatchSetsPaginator,
      ListSubscribedRuleGroupsPaginator,
      ListWebACLsPaginator,
      ListXssMatchSetsPaginator,
  )

  session = get_session()
  async with session.create_client("waf") as client:
      client: WAFClient

      
      
      get_rate_based_rule_managed_keys_paginator: GetRateBasedRuleManagedKeysPaginator = (
          client.get_paginator("get_rate_based_rule_managed_keys")
      )
      list_activated_rules_in_rule_group_paginator: ListActivatedRulesInRuleGroupPaginator = (
          client.get_paginator("list_activated_rules_in_rule_group")
      )
      list_byte_match_sets_paginator: ListByteMatchSetsPaginator = client.get_paginator(
          "list_byte_match_sets"
      )
      list_geo_match_sets_paginator: ListGeoMatchSetsPaginator = client.get_paginator(
          "list_geo_match_sets"
      )
      list_ip_sets_paginator: ListIPSetsPaginator = client.get_paginator("list_ip_sets")
      list_logging_configurations_paginator: ListLoggingConfigurationsPaginator = (
          client.get_paginator("list_logging_configurations")
      )
      list_rate_based_rules_paginator: ListRateBasedRulesPaginator = client.get_paginator(
          "list_rate_based_rules"
      )
      list_regex_match_sets_paginator: ListRegexMatchSetsPaginator = client.get_paginator(
          "list_regex_match_sets"
      )
      list_regex_pattern_sets_paginator: ListRegexPatternSetsPaginator = client.get_paginator(
          "list_regex_pattern_sets"
      )
      list_rule_groups_paginator: ListRuleGroupsPaginator = client.get_paginator("list_rule_groups")
      list_rules_paginator: ListRulesPaginator = client.get_paginator("list_rules")
      list_size_constraint_sets_paginator: ListSizeConstraintSetsPaginator = client.get_paginator(
          "list_size_constraint_sets"
      )
      list_sql_injection_match_sets_paginator: ListSqlInjectionMatchSetsPaginator = (
          client.get_paginator("list_sql_injection_match_sets")
      )
      list_subscribed_rule_groups_paginator: ListSubscribedRuleGroupsPaginator = client.get_paginator(
          "list_subscribed_rule_groups"
      )
      list_web_acls_paginator: ListWebACLsPaginator = client.get_paginator("list_web_acls")
      list_xss_match_sets_paginator: ListXssMatchSetsPaginator = client.get_paginator(
          "list_xss_match_sets"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_waf.literals import ChangeActionType


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

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



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

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

  ```python
  from types_aiobotocore_waf.type_defs import ExcludedRuleTypeDef


  def get_value() -> ExcludedRuleTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-waf` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_waf/)

  <a id="support-and-contributing"></a>



  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.


pkgId: c00deb8e8f6588e734fd475b2d556686c3be1dcc0283c5a2edccb63c48dbb967
name: python-types-aiobotocore-waf-regional-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-waf-regional
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-waf-regional-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-waf-regional-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-waf-regional"></a>



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

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

  Type annotations for
  [aiobotocore WAFRegional 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-waf-regional docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_waf_regional/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-waf-regional](#types-aiobotocore-waf-regional)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WAFRegional` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[waf-regional]'



  python -m pip install 'types-aiobotocore-lite[waf-regional]'


  python -m pip install types-aiobotocore-waf-regional
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-waf-regional
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[waf-regional]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[waf-regional]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[waf-regional]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-waf-regional` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WAFRegionalClient` provides annotations for
  `session.create_client("waf-regional")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_waf_regional import WAFRegionalClient

  session = get_session()
  async with session.create_client("waf-regional") as client:
      client: WAFRegionalClient
      
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_waf_regional.literals import ChangeActionType


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

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



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

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

  ```python
  from types_aiobotocore_waf_regional.type_defs import ExcludedRuleTypeDef


  def get_value() -> ExcludedRuleTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-waf-regional` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_waf_regional/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 92df37e1af15bb93e3af4e4fa9490ed6a3af116d9508abf083de291d39a79fa9
name: python-types-aiobotocore-wafv2-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-wafv2
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-wafv2-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-wafv2-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-wafv2"></a>



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

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

  Type annotations for
  [aiobotocore WAFV2 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-wafv2 docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_wafv2/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-wafv2](#types-aiobotocore-wafv2)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WAFV2` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[wafv2]'



  python -m pip install 'types-aiobotocore-lite[wafv2]'


  python -m pip install types-aiobotocore-wafv2
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-wafv2
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[wafv2]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[wafv2]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[wafv2]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-wafv2` dependency in production. However, there is an issue
  in `pylint` that it complains about undefined variables. To fix it, set all
  types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WAFV2Client` provides annotations for `session.create_client("wafv2")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_wafv2 import WAFV2Client

  session = get_session()
  async with session.create_client("wafv2") as client:
      client: WAFV2Client
      
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_wafv2.literals import ActionValueType


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

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



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

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

  ```python
  from types_aiobotocore_wafv2.type_defs import APIKeySummaryTypeDef


  def get_value() -> APIKeySummaryTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-wafv2` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_wafv2/)

  <a id="support-and-contributing"></a>



  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.


pkgId: ff151bfdc3ccf96e61cf426a95f996cd6584f1403d16a87165fcba8d9e429c94
name: python-types-aiobotocore-wellarchitected-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-wellarchitected
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-wellarchitected-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-wellarchitected-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-wellarchitected"></a>



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

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

  Type annotations for
  [aiobotocore WellArchitected 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-wellarchitected docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_wellarchitected/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-wellarchitected](#types-aiobotocore-wellarchitected)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WellArchitected` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[wellarchitected]'



  python -m pip install 'types-aiobotocore-lite[wellarchitected]'


  python -m pip install types-aiobotocore-wellarchitected
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-wellarchitected
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[wellarchitected]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[wellarchitected]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[wellarchitected]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-wellarchitected` dependency in production. However, there is
  an issue in `pylint` that it complains about undefined variables. To fix it,
  set all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WellArchitectedClient` provides annotations for
  `session.create_client("wellarchitected")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_wellarchitected import WellArchitectedClient

  session = get_session()
  async with session.create_client("wellarchitected") as client:
      client: WellArchitectedClient
      
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_wellarchitected.literals import AccountJiraIssueManagementStatusType


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

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



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

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

  ```python
  from types_aiobotocore_wellarchitected.type_defs import AccountJiraConfigurationInputTypeDef


  def get_value() -> AccountJiraConfigurationInputTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-wellarchitected` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_wellarchitected/)

  <a id="support-and-contributing"></a>



  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.


pkgId: fc34d0afe25648c84a7d5bc6cd67cd5a25bb1faa4c15265911e6234c8b982ab3
name: python-types-aiobotocore-wisdom-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-wisdom
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-wisdom-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-wisdom-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-wisdom"></a>



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

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

  Type annotations for
  [aiobotocore ConnectWisdomService 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-wisdom docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_wisdom/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-wisdom](#types-aiobotocore-wisdom)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `ConnectWisdomService` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[wisdom]'



  python -m pip install 'types-aiobotocore-lite[wisdom]'


  python -m pip install types-aiobotocore-wisdom
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-wisdom
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[wisdom]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[wisdom]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[wisdom]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-wisdom` dependency in production. However, there is an issue
  in `pylint` that it complains about undefined variables. To fix it, set all
  types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `ConnectWisdomServiceClient` provides annotations for
  `session.create_client("wisdom")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_wisdom import ConnectWisdomServiceClient

  session = get_session()
  async with session.create_client("wisdom") as client:
      client: ConnectWisdomServiceClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_wisdom import ConnectWisdomServiceClient
  from types_aiobotocore_wisdom.paginator import (
      ListAssistantAssociationsPaginator,
      ListAssistantsPaginator,
      ListContentsPaginator,
      ListImportJobsPaginator,
      ListKnowledgeBasesPaginator,
      ListQuickResponsesPaginator,
      QueryAssistantPaginator,
      SearchContentPaginator,
      SearchQuickResponsesPaginator,
      SearchSessionsPaginator,
  )

  session = get_session()
  async with session.create_client("wisdom") as client:
      client: ConnectWisdomServiceClient

      
      
      list_assistant_associations_paginator: ListAssistantAssociationsPaginator = (
          client.get_paginator("list_assistant_associations")
      )
      list_assistants_paginator: ListAssistantsPaginator = client.get_paginator("list_assistants")
      list_contents_paginator: ListContentsPaginator = client.get_paginator("list_contents")
      list_import_jobs_paginator: ListImportJobsPaginator = client.get_paginator("list_import_jobs")
      list_knowledge_bases_paginator: ListKnowledgeBasesPaginator = client.get_paginator(
          "list_knowledge_bases"
      )
      list_quick_responses_paginator: ListQuickResponsesPaginator = client.get_paginator(
          "list_quick_responses"
      )
      query_assistant_paginator: QueryAssistantPaginator = client.get_paginator("query_assistant")
      search_content_paginator: SearchContentPaginator = client.get_paginator("search_content")
      search_quick_responses_paginator: SearchQuickResponsesPaginator = client.get_paginator(
          "search_quick_responses"
      )
      search_sessions_paginator: SearchSessionsPaginator = client.get_paginator("search_sessions")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_wisdom.literals import AssistantStatusType


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

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



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

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

  ```python
  from types_aiobotocore_wisdom.type_defs import AppIntegrationsConfigurationOutputTypeDef


  def get_value() -> AppIntegrationsConfigurationOutputTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-wisdom` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_wisdom/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 0dc5dbf755e9d31e2914434d368a12073f53f49b289904e472c0192c83ceae27
name: python-types-aiobotocore-workdocs-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-workdocs
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-workdocs-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-workdocs-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-workdocs"></a>



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

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

  Type annotations for
  [aiobotocore WorkDocs 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-workdocs docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workdocs/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-workdocs](#types-aiobotocore-workdocs)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WorkDocs` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[workdocs]'



  python -m pip install 'types-aiobotocore-lite[workdocs]'


  python -m pip install types-aiobotocore-workdocs
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-workdocs
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[workdocs]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[workdocs]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[workdocs]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-workdocs` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WorkDocsClient` provides annotations for `session.create_client("workdocs")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workdocs import WorkDocsClient

  session = get_session()
  async with session.create_client("workdocs") as client:
      client: WorkDocsClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workdocs import WorkDocsClient
  from types_aiobotocore_workdocs.paginator import (
      DescribeActivitiesPaginator,
      DescribeCommentsPaginator,
      DescribeDocumentVersionsPaginator,
      DescribeFolderContentsPaginator,
      DescribeGroupsPaginator,
      DescribeNotificationSubscriptionsPaginator,
      DescribeResourcePermissionsPaginator,
      DescribeRootFoldersPaginator,
      DescribeUsersPaginator,
      SearchResourcesPaginator,
  )

  session = get_session()
  async with session.create_client("workdocs") as client:
      client: WorkDocsClient

      
      
      describe_activities_paginator: DescribeActivitiesPaginator = client.get_paginator(
          "describe_activities"
      )
      describe_comments_paginator: DescribeCommentsPaginator = client.get_paginator(
          "describe_comments"
      )
      describe_document_versions_paginator: DescribeDocumentVersionsPaginator = client.get_paginator(
          "describe_document_versions"
      )
      describe_folder_contents_paginator: DescribeFolderContentsPaginator = client.get_paginator(
          "describe_folder_contents"
      )
      describe_groups_paginator: DescribeGroupsPaginator = client.get_paginator("describe_groups")
      describe_notification_subscriptions_paginator: DescribeNotificationSubscriptionsPaginator = (
          client.get_paginator("describe_notification_subscriptions")
      )
      describe_resource_permissions_paginator: DescribeResourcePermissionsPaginator = (
          client.get_paginator("describe_resource_permissions")
      )
      describe_root_folders_paginator: DescribeRootFoldersPaginator = client.get_paginator(
          "describe_root_folders"
      )
      describe_users_paginator: DescribeUsersPaginator = client.get_paginator("describe_users")
      search_resources_paginator: SearchResourcesPaginator = client.get_paginator("search_resources")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_workdocs.literals import ActivityTypeType


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

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



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

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

  ```python
  from types_aiobotocore_workdocs.type_defs import AbortDocumentVersionUploadRequestRequestTypeDef


  def get_value() -> AbortDocumentVersionUploadRequestRequestTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-workdocs` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workdocs/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 5c8cc439dea2979609fddc8a5bd615ea8bcd78e626252870b250fa302e3e1d8d
name: python-types-aiobotocore-workmail-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-workmail
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-workmail-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-workmail-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-workmail"></a>



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

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

  Type annotations for
  [aiobotocore WorkMail 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-workmail docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workmail/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-workmail](#types-aiobotocore-workmail)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WorkMail` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[workmail]'



  python -m pip install 'types-aiobotocore-lite[workmail]'


  python -m pip install types-aiobotocore-workmail
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-workmail
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[workmail]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[workmail]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[workmail]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-workmail` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WorkMailClient` provides annotations for `session.create_client("workmail")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workmail import WorkMailClient

  session = get_session()
  async with session.create_client("workmail") as client:
      client: WorkMailClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workmail import WorkMailClient
  from types_aiobotocore_workmail.paginator import (
      ListAliasesPaginator,
      ListAvailabilityConfigurationsPaginator,
      ListGroupMembersPaginator,
      ListGroupsPaginator,
      ListMailboxPermissionsPaginator,
      ListOrganizationsPaginator,
      ListPersonalAccessTokensPaginator,
      ListResourceDelegatesPaginator,
      ListResourcesPaginator,
      ListUsersPaginator,
  )

  session = get_session()
  async with session.create_client("workmail") as client:
      client: WorkMailClient

      
      
      list_aliases_paginator: ListAliasesPaginator = client.get_paginator("list_aliases")
      list_availability_configurations_paginator: ListAvailabilityConfigurationsPaginator = (
          client.get_paginator("list_availability_configurations")
      )
      list_group_members_paginator: ListGroupMembersPaginator = client.get_paginator(
          "list_group_members"
      )
      list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
      list_mailbox_permissions_paginator: ListMailboxPermissionsPaginator = client.get_paginator(
          "list_mailbox_permissions"
      )
      list_organizations_paginator: ListOrganizationsPaginator = client.get_paginator(
          "list_organizations"
      )
      list_personal_access_tokens_paginator: ListPersonalAccessTokensPaginator = client.get_paginator(
          "list_personal_access_tokens"
      )
      list_resource_delegates_paginator: ListResourceDelegatesPaginator = client.get_paginator(
          "list_resource_delegates"
      )
      list_resources_paginator: ListResourcesPaginator = client.get_paginator("list_resources")
      list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_workmail.literals import AccessControlRuleEffectType


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

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



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

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

  ```python
  from types_aiobotocore_workmail.type_defs import AccessControlRuleTypeDef


  def get_value() -> AccessControlRuleTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-workmail` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workmail/)

  <a id="support-and-contributing"></a>



  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.


pkgId: fd7bc2a82c2468573a353f8abc5e1c3ff0297b1ee72f9c0d130aecf145096708
name: python-types-aiobotocore-workmailmessageflow-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-workmailmessageflow
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-workmailmessageflow-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-workmailmessageflow-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-workmailmessageflow"></a>



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

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

  Type annotations for
  [aiobotocore WorkMailMessageFlow 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-workmailmessageflow docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workmailmessageflow/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-workmailmessageflow](#types-aiobotocore-workmailmessageflow)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WorkMailMessageFlow` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[workmailmessageflow]'



  python -m pip install 'types-aiobotocore-lite[workmailmessageflow]'


  python -m pip install types-aiobotocore-workmailmessageflow
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-workmailmessageflow
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[workmailmessageflow]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[workmailmessageflow]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[workmailmessageflow]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-workmailmessageflow` dependency in production. However,
  there is an issue in `pylint` that it complains about undefined variables. To
  fix it, set all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WorkMailMessageFlowClient` provides annotations for
  `session.create_client("workmailmessageflow")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workmailmessageflow import WorkMailMessageFlowClient

  session = get_session()
  async with session.create_client("workmailmessageflow") as client:
      client: WorkMailMessageFlowClient
      
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_workmailmessageflow.literals import WorkMailMessageFlowServiceName


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

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



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

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

  ```python
  from types_aiobotocore_workmailmessageflow.type_defs import (
      GetRawMessageContentRequestRequestTypeDef,
  )


  def get_value() -> GetRawMessageContentRequestRequestTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-workmailmessageflow` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workmailmessageflow/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 9acd1b445451d9ea434b0f297ce9b540d79d5983b1fd4c7b4d85ad1ac3f2a808
name: python-types-aiobotocore-workspaces-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-workspaces
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-workspaces-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-workspaces-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-workspaces"></a>



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

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

  Type annotations for
  [aiobotocore WorkSpaces 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-workspaces docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-workspaces](#types-aiobotocore-workspaces)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WorkSpaces` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[workspaces]'



  python -m pip install 'types-aiobotocore-lite[workspaces]'


  python -m pip install types-aiobotocore-workspaces
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-workspaces
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[workspaces]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[workspaces]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[workspaces]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-workspaces` dependency in production. However, there is an
  issue in `pylint` that it complains about undefined variables. To fix it, set
  all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WorkSpacesClient` provides annotations for
  `session.create_client("workspaces")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workspaces import WorkSpacesClient

  session = get_session()
  async with session.create_client("workspaces") as client:
      client: WorkSpacesClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workspaces import WorkSpacesClient
  from types_aiobotocore_workspaces.paginator import (
      DescribeAccountModificationsPaginator,
      DescribeIpGroupsPaginator,
      DescribeWorkspaceBundlesPaginator,
      DescribeWorkspaceDirectoriesPaginator,
      DescribeWorkspaceImagesPaginator,
      DescribeWorkspacesConnectionStatusPaginator,
      DescribeWorkspacesPaginator,
      ListAccountLinksPaginator,
      ListAvailableManagementCidrRangesPaginator,
  )

  session = get_session()
  async with session.create_client("workspaces") as client:
      client: WorkSpacesClient

      
      
      describe_account_modifications_paginator: DescribeAccountModificationsPaginator = (
          client.get_paginator("describe_account_modifications")
      )
      describe_ip_groups_paginator: DescribeIpGroupsPaginator = client.get_paginator(
          "describe_ip_groups"
      )
      describe_workspace_bundles_paginator: DescribeWorkspaceBundlesPaginator = client.get_paginator(
          "describe_workspace_bundles"
      )
      describe_workspace_directories_paginator: DescribeWorkspaceDirectoriesPaginator = (
          client.get_paginator("describe_workspace_directories")
      )
      describe_workspace_images_paginator: DescribeWorkspaceImagesPaginator = client.get_paginator(
          "describe_workspace_images"
      )
      describe_workspaces_connection_status_paginator: DescribeWorkspacesConnectionStatusPaginator = (
          client.get_paginator("describe_workspaces_connection_status")
      )
      describe_workspaces_paginator: DescribeWorkspacesPaginator = client.get_paginator(
          "describe_workspaces"
      )
      list_account_links_paginator: ListAccountLinksPaginator = client.get_paginator(
          "list_account_links"
      )
      list_available_management_cidr_ranges_paginator: ListAvailableManagementCidrRangesPaginator = (
          client.get_paginator("list_available_management_cidr_ranges")
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_workspaces.literals import AccessPropertyValueType


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

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



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

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

  ```python
  from types_aiobotocore_workspaces.type_defs import AcceptAccountLinkInvitationRequestRequestTypeDef


  def get_value() -> AcceptAccountLinkInvitationRequestRequestTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-workspaces` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 5448c60ad62be4493df714a50b9f46ebd964ee862e6f0917071e9b12eb3e13c5
name: python-types-aiobotocore-workspaces-thin-client-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-workspaces-thin-client
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-workspaces-thin-client-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-workspaces-thin-client-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-workspaces-thin-client"></a>



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

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

  Type annotations for
  [aiobotocore WorkSpacesThinClient 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-workspaces-thin-client docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_thin_client/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-workspaces-thin-client](#types-aiobotocore-workspaces-thin-client)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WorkSpacesThinClient` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[workspaces-thin-client]'



  python -m pip install 'types-aiobotocore-lite[workspaces-thin-client]'


  python -m pip install types-aiobotocore-workspaces-thin-client
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-workspaces-thin-client
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[workspaces-thin-client]` in your environment:

  ```bash
  python -m pip install 'types-aiobotocore[workspaces-thin-client]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[workspaces-thin-client]` in your environment:

  ```bash
  python -m pip install 'types-aiobotocore[workspaces-thin-client]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-aiobotocore[workspaces-thin-client]'
  ```

  - 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>



  - Install `types-aiobotocore[workspaces-thin-client]` with services you use in
    your environment:

  ```bash
  python -m pip install 'types-aiobotocore[workspaces-thin-client]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[workspaces-thin-client]` in your environment:

  ```bash
  python -m pip install 'types-aiobotocore[workspaces-thin-client]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-aiobotocore[workspaces-thin-client]` in your environment:

  ```bash
  python -m pip install 'types-aiobotocore[workspaces-thin-client]'
  ```

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-workspaces-thin-client` dependency in production. However,
  there is an issue in `pylint` that it complains about undefined variables. To
  fix it, set all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WorkSpacesThinClientClient` provides annotations for
  `session.create_client("workspaces-thin-client")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workspaces_thin_client import WorkSpacesThinClientClient

  session = get_session()
  async with session.create_client("workspaces-thin-client") as client:
      client: WorkSpacesThinClientClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workspaces_thin_client import WorkSpacesThinClientClient
  from types_aiobotocore_workspaces_thin_client.paginator import (
      ListDevicesPaginator,
      ListEnvironmentsPaginator,
      ListSoftwareSetsPaginator,
  )

  session = get_session()
  async with session.create_client("workspaces-thin-client") as client:
      client: WorkSpacesThinClientClient

      
      
      list_devices_paginator: ListDevicesPaginator = client.get_paginator("list_devices")
      list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator(
          "list_environments"
      )
      list_software_sets_paginator: ListSoftwareSetsPaginator = client.get_paginator(
          "list_software_sets"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_workspaces_thin_client.literals import ApplyTimeOfType


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

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



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

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

  ```python
  from types_aiobotocore_workspaces_thin_client.type_defs import MaintenanceWindowTypeDef


  def get_value() -> MaintenanceWindowTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-workspaces-thin-client` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_thin_client/)

  <a id="support-and-contributing"></a>



  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.


pkgId: ae2951174c3b21cb33b7387c3372c481a3b6ddb836c076d05458e653093f49d2
name: python-types-aiobotocore-workspaces-web-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-workspaces-web
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-workspaces-web-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-workspaces-web-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-workspaces-web"></a>



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

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

  Type annotations for
  [aiobotocore WorkSpacesWeb 2.16.0](https://pypi.org/project/aiobotocore/)
  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 with
  [mypy-boto3-builder 8.6.4](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-workspaces-web docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_web/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-workspaces-web](#types-aiobotocore-workspaces-web)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `WorkSpacesWeb` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[workspaces-web]'



  python -m pip install 'types-aiobotocore-lite[workspaces-web]'


  python -m pip install types-aiobotocore-workspaces-web
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-workspaces-web
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[workspaces-web]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[workspaces-web]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[workspaces-web]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-workspaces-web` dependency in production. However, there is
  an issue in `pylint` that it complains about undefined variables. To fix it,
  set all types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `WorkSpacesWebClient` provides annotations for
  `session.create_client("workspaces-web")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workspaces_web import WorkSpacesWebClient

  session = get_session()
  async with session.create_client("workspaces-web") as client:
      client: WorkSpacesWebClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_workspaces_web import WorkSpacesWebClient
  from types_aiobotocore_workspaces_web.paginator import (
      ListDataProtectionSettingsPaginator,
      ListSessionsPaginator,
  )

  session = get_session()
  async with session.create_client("workspaces-web") as client:
      client: WorkSpacesWebClient

      
      
      list_data_protection_settings_paginator: ListDataProtectionSettingsPaginator = (
          client.get_paginator("list_data_protection_settings")
      )
      list_sessions_paginator: ListSessionsPaginator = client.get_paginator("list_sessions")
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_workspaces_web.literals import AuthenticationTypeType


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

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



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

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

  ```python
  from types_aiobotocore_workspaces_web.type_defs import AssociateBrowserSettingsRequestRequestTypeDef


  def get_value() -> AssociateBrowserSettingsRequestRequestTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-workspaces-web` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_workspaces_web/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 700578c0dedfd165dbca1b4917ea4a09ea3fac5acee6cee09e39624525fc6c55
name: python-types-aiobotocore-xray-help
arch: noarch
version: 2.16.0
epoch: 0
release: 1
summary: Development documents and examples for types-aiobotocore-xray
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-aiobotocore-xray-2.16.0-1.src.rpm
location_href: Packages/python-types-aiobotocore-xray-help-2.16.0-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-aiobotocore-xray"></a>



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

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

  Type annotations for
  [aiobotocore XRay 2.16.0](https://pypi.org/project/aiobotocore/) 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 with
  [mypy-boto3-builder 8.6.4](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-xray docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_xray/).

  See how it helps you find and fix potential bugs:

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

  - [types-aiobotocore-xray](#types-aiobotocore-xray)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `aiobotocore` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'aiobotocore==2.16.0' mypy_boto3_builder`
  2. Select `aiobotocore` AWS SDK.
  3. Add `XRay` service.
  4. Use provided commands to install generated packages.

  <a id="from-pypi-with-pip"></a>



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

  ```bash

  python -m pip install 'types-aiobotocore[xray]'



  python -m pip install 'types-aiobotocore-lite[xray]'


  python -m pip install types-aiobotocore-xray
  ```

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



  ```bash
  python -m pip uninstall -y types-aiobotocore-xray
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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[xray]` in your environment:

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

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/)
  > until the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-aiobotocore` with
  > [types-aiobotocore-lite](https://pypi.org/project/types-aiobotocore-lite/):

  ```bash
  pip uninstall types-aiobotocore
  pip install types-aiobotocore-lite
  ```

  Install `types-aiobotocore[xray]` in your environment:

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

  Both type checking and code completion should now work.

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



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

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

  - 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>



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

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

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-aiobotocore[xray]` in your environment:

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

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

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



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

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

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

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-aiobotocore-xray` dependency in production. However, there is an issue
  in `pylint` that it complains about undefined variables. To fix it, set all
  types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_aiobotocore_ec2 import EC2Client, EC2ServiceResource
      from types_aiobotocore_ec2.waiters import BundleTaskCompleteWaiter
      from types_aiobotocore_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `XRayClient` provides annotations for `session.create_client("xray")`.

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_xray import XRayClient

  session = get_session()
  async with session.create_client("xray") as client:
      client: XRayClient
      
  ```

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



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

  ```python
  from aiobotocore.session import get_session

  from types_aiobotocore_xray import XRayClient
  from types_aiobotocore_xray.paginator import (
      BatchGetTracesPaginator,
      GetGroupsPaginator,
      GetSamplingRulesPaginator,
      GetSamplingStatisticSummariesPaginator,
      GetServiceGraphPaginator,
      GetTimeSeriesServiceStatisticsPaginator,
      GetTraceGraphPaginator,
      GetTraceSummariesPaginator,
      ListResourcePoliciesPaginator,
      ListTagsForResourcePaginator,
  )

  session = get_session()
  async with session.create_client("xray") as client:
      client: XRayClient

      
      
      batch_get_traces_paginator: BatchGetTracesPaginator = client.get_paginator("batch_get_traces")
      get_groups_paginator: GetGroupsPaginator = client.get_paginator("get_groups")
      get_sampling_rules_paginator: GetSamplingRulesPaginator = client.get_paginator(
          "get_sampling_rules"
      )
      get_sampling_statistic_summaries_paginator: GetSamplingStatisticSummariesPaginator = (
          client.get_paginator("get_sampling_statistic_summaries")
      )
      get_service_graph_paginator: GetServiceGraphPaginator = client.get_paginator(
          "get_service_graph"
      )
      get_time_series_service_statistics_paginator: GetTimeSeriesServiceStatisticsPaginator = (
          client.get_paginator("get_time_series_service_statistics")
      )
      get_trace_graph_paginator: GetTraceGraphPaginator = client.get_paginator("get_trace_graph")
      get_trace_summaries_paginator: GetTraceSummariesPaginator = client.get_paginator(
          "get_trace_summaries"
      )
      list_resource_policies_paginator: ListResourcePoliciesPaginator = client.get_paginator(
          "list_resource_policies"
      )
      list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
          "list_tags_for_resource"
      )
  ```

  <a id="literals"></a>



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

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

  ```python
  from types_aiobotocore_xray.literals import BatchGetTracesPaginatorName


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

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



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

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

  ```python
  from types_aiobotocore_xray.type_defs import AliasTypeDef


  def get_value() -> AliasTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-aiobotocore-xray` 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>



  - [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>



  All services type annotations can be found in
  [aiobotocore docs](https://youtype.github.io/types_aiobotocore_docs/types_aiobotocore_xray/)

  <a id="support-and-contributing"></a>



  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.


pkgId: aa0f64c2ff04bf345e0945cb833a57c5909fe1be01921326502e28496bb1fc27
name: python-types-all-v2-help
arch: noarch
version: 2.0.4
epoch: 0
release: 1
summary: Development documents and examples for types-all-v2
url: https://github.com/Morry98/types-all-v2
rpm_license: MIT
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-all-v2-2.0.4-1.src.rpm
location_href: Packages/python-types-all-v2-help-2.0.4-1.noarch.rpm
checksum_type: sha256
description:
  A shim for the typeshed changes in mypy 0.900

  ```bash
  pip install types-all-v2
  ```

  `--install-types` is annoying, this installs all the things in [typeshed]
  ```
  error: Library stubs not installed for "toml" (or incompatible with Python 3.8)
  ```
  (for pre-commit, use something like this)
  ```yaml
  -   repo: https://github.com/pre-commit/mirrors-mypy
      rev: v0.902
      hooks:
      -   id: mypy
          additional_dependencies: [types-all-v2]
  ```
  [typeshed]: https://github.com/python/typeshed


pkgId: a73a7afbe6a98e9c033d13359cd637f06470656994c4c338489eaaa7362ff083
name: python-types-awscrt-help
arch: noarch
version: 0.23.5
epoch: 0
release: 1
summary: Development documents and examples for types-awscrt
url: https://github.com/youtype/types-awscrt
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-awscrt-0.23.5-1.src.rpm
location_href: Packages/python-types-awscrt-help-0.23.5-1.noarch.rpm
checksum_type: sha256
description:
  [![PyPI - types-awscrt](https://img.shields.io/pypi/v/types-awscrt.svg?color=blue&label=types-awscrt)](https://pypi.org/project/types-awscrt)
  [![PyPI - awscrt](https://img.shields.io/pypi/v/awscrt.svg?color=blue&label=awscrt)](https://pypi.org/project/awscrt)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-awscrt.svg?color=blue)](https://pypi.org/project/types-awscrt)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-awscrt)](https://pypistats.org/packages/types-awscrt)

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

  Type annotations and code completion for [awscrt](https://pypi.org/project/awscrt/) package.
  This package is a part of [mypy_boto3_builder](https://github.com/youtype/mypy_boto3_builder) project.

  [![Publish botocore-stubs](https://github.com/youtype/botocore-stubs/actions/workflows/publish_on_update.yml/badge.svg)](https://github.com/youtype/botocore-stubs/actions/workflows/publish_on_update.yml)
  [![Publish types-awscrt](https://github.com/youtype/types-awscrt/actions/workflows/publish_on_update.yml/badge.svg)](https://github.com/youtype/types-awscrt/actions/workflows/publish_on_update.yml)
  [![Publish types-s3transfer](https://github.com/youtype/types-s3transfer/actions/workflows/publish_on_update.yml/badge.svg)](https://github.com/youtype/types-s3transfer/actions/workflows/publish_on_update.yml)

  - [types-awscrt](#types-awscrt)
    - [Installation](#installation)
    - [Usage](#usage)
    - [Versioning](#versioning)
    - [Support and contributing](#support-and-contributing)




  ```bash
  python -m pip install types-awscrt
  ```



  Use [mypy](https://github.com/python/mypy) or [pyright](https://github.com/microsoft/pyright) for type checking.



  `types-awscrt` version is the same as related `awscrt` version and follows
  [PEP 440](https://www.python.org/dev/peps/pep-0440/) format.



  Please reports any bugs or request new features in
  [types-awscrt](https://github.com/youtype/types-awscrt/issues/) repository.

rpm_license:
  MIT License  Copyright (c) 2022 Vlad Emelianov  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


pkgId: 9930234d02ee9b0506b5f92b29f09243127f0bf592774b26d31b640d4cc52a46
name: python-types-boto3-account-help
arch: noarch
version: 1.35.83
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-account
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-account-1.35.83-1.src.rpm
location_href: Packages/python-types-boto3-account-help-1.35.83-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-account"></a>



  [![PyPI - types-boto3-account](https://img.shields.io/pypi/v/types-boto3-account.svg?color=blue)](https://pypi.org/project/types-boto3-account/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-account.svg?color=blue)](https://pypi.org/project/types-boto3-account/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-account)](https://pypistats.org/packages/types-boto3-account)

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

  Type annotations for [boto3 Account 1.35.83](https://pypi.org/project/boto3/)
  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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-account docs](https://youtype.github.io/types_boto3_docs/types_boto3_account/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-account](#types-boto3-account)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.83' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `Account` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `Account`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `Account` service.

  ```bash

  python -m pip install 'types-boto3[account]'



  python -m pip install 'types-boto3-lite[account]'


  python -m pip install types-boto3-account
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-account
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[account]` in your environment:

  ```bash
  python -m pip install 'types-boto3[account]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[account]` in your environment:

  ```bash
  python -m pip install 'types-boto3[account]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[account]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[account]` with services you use in your environment:

  ```bash
  python -m pip install 'types-boto3[account]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[account]` in your environment:

  ```bash
  python -m pip install 'types-boto3[account]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[account]` in your environment:

  ```bash
  python -m pip install 'types-boto3[account]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-account` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `AccountClient` provides annotations for `boto3.client("account")`.

  ```python
  from boto3.session import Session

  from types_boto3_account import AccountClient

  client: AccountClient = Session().client("account")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_account import AccountClient
  from types_boto3_account.paginator import ListRegionsPaginator

  client: AccountClient = Session().client("account")



  list_regions_paginator: ListRegionsPaginator = client.get_paginator("list_regions")
  ```

  <a id="literals"></a>



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

  Full list of `Account` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_account/literals/).

  ```python
  from types_boto3_account.literals import AlternateContactTypeType


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

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



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

  Full list of `Account` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_account/type_defs/).

  ```python
  from types_boto3_account.type_defs import AcceptPrimaryEmailUpdateRequestRequestTypeDef


  def get_value() -> AcceptPrimaryEmailUpdateRequestRequestTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-account` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_account/)

  <a id="support-and-contributing"></a>



  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.


pkgId: b742bb5c6a3c610e35e5e75e7f687fcb463ed6545618d25bcaeea7a37f7c1de1
name: python-types-boto3-amplify-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-amplify
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-amplify-1.35.84-1.src.rpm
location_href: Packages/python-types-boto3-amplify-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-amplify"></a>



  [![PyPI - types-boto3-amplify](https://img.shields.io/pypi/v/types-boto3-amplify.svg?color=blue)](https://pypi.org/project/types-boto3-amplify/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-amplify.svg?color=blue)](https://pypi.org/project/types-boto3-amplify/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-amplify)](https://pypistats.org/packages/types-boto3-amplify)

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

  Type annotations for [boto3 Amplify 1.35.84](https://pypi.org/project/boto3/)
  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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-amplify docs](https://youtype.github.io/types_boto3_docs/types_boto3_amplify/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-amplify](#types-boto3-amplify)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.84' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `Amplify` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `Amplify`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `Amplify` service.

  ```bash

  python -m pip install 'types-boto3[amplify]'



  python -m pip install 'types-boto3-lite[amplify]'


  python -m pip install types-boto3-amplify
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-amplify
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[amplify]` in your environment:

  ```bash
  python -m pip install 'types-boto3[amplify]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[amplify]` in your environment:

  ```bash
  python -m pip install 'types-boto3[amplify]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[amplify]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[amplify]` with services you use in your environment:

  ```bash
  python -m pip install 'types-boto3[amplify]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[amplify]` in your environment:

  ```bash
  python -m pip install 'types-boto3[amplify]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[amplify]` in your environment:

  ```bash
  python -m pip install 'types-boto3[amplify]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-amplify` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `AmplifyClient` provides annotations for `boto3.client("amplify")`.

  ```python
  from boto3.session import Session

  from types_boto3_amplify import AmplifyClient

  client: AmplifyClient = Session().client("amplify")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_amplify import AmplifyClient
  from types_boto3_amplify.paginator import (
      ListAppsPaginator,
      ListBranchesPaginator,
      ListDomainAssociationsPaginator,
      ListJobsPaginator,
  )

  client: AmplifyClient = Session().client("amplify")



  list_apps_paginator: ListAppsPaginator = client.get_paginator("list_apps")
  list_branches_paginator: ListBranchesPaginator = client.get_paginator("list_branches")
  list_domain_associations_paginator: ListDomainAssociationsPaginator = client.get_paginator(
      "list_domain_associations"
  )
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
  ```

  <a id="literals"></a>



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

  Full list of `Amplify` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_amplify/literals/).

  ```python
  from types_boto3_amplify.literals import CacheConfigTypeType


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

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



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

  Full list of `Amplify` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_amplify/type_defs/).

  ```python
  from types_boto3_amplify.type_defs import AutoBranchCreationConfigOutputTypeDef


  def get_value() -> AutoBranchCreationConfigOutputTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-amplify` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_amplify/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 154dc8757e69af7208d23fb058ba95ea1cfd0e536fba8b8b65ecc0266472242b
name: python-types-boto3-appstream-help
arch: noarch
version: 1.35.85
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-appstream
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-appstream-1.35.85-1.src.rpm
location_href: Packages/python-types-boto3-appstream-help-1.35.85-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-appstream"></a>



  [![PyPI - types-boto3-appstream](https://img.shields.io/pypi/v/types-boto3-appstream.svg?color=blue)](https://pypi.org/project/types-boto3-appstream/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-appstream.svg?color=blue)](https://pypi.org/project/types-boto3-appstream/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-appstream)](https://pypistats.org/packages/types-boto3-appstream)

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

  Type annotations for [boto3 AppStream 1.35.85](https://pypi.org/project/boto3/)
  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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-appstream docs](https://youtype.github.io/types_boto3_docs/types_boto3_appstream/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-appstream](#types-boto3-appstream)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.85' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `AppStream` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `AppStream`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `AppStream` service.

  ```bash

  python -m pip install 'types-boto3[appstream]'



  python -m pip install 'types-boto3-lite[appstream]'


  python -m pip install types-boto3-appstream
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-appstream
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[appstream]` in your environment:

  ```bash
  python -m pip install 'types-boto3[appstream]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[appstream]` in your environment:

  ```bash
  python -m pip install 'types-boto3[appstream]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[appstream]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[appstream]` with services you use in your environment:

  ```bash
  python -m pip install 'types-boto3[appstream]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[appstream]` in your environment:

  ```bash
  python -m pip install 'types-boto3[appstream]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[appstream]` in your environment:

  ```bash
  python -m pip install 'types-boto3[appstream]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-appstream` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `AppStreamClient` provides annotations for `boto3.client("appstream")`.

  ```python
  from boto3.session import Session

  from types_boto3_appstream import AppStreamClient

  client: AppStreamClient = Session().client("appstream")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_appstream import AppStreamClient
  from types_boto3_appstream.paginator import (
      DescribeDirectoryConfigsPaginator,
      DescribeFleetsPaginator,
      DescribeImageBuildersPaginator,
      DescribeImagesPaginator,
      DescribeSessionsPaginator,
      DescribeStacksPaginator,
      DescribeUserStackAssociationsPaginator,
      DescribeUsersPaginator,
      ListAssociatedFleetsPaginator,
      ListAssociatedStacksPaginator,
  )

  client: AppStreamClient = Session().client("appstream")



  describe_directory_configs_paginator: DescribeDirectoryConfigsPaginator = client.get_paginator(
      "describe_directory_configs"
  )
  describe_fleets_paginator: DescribeFleetsPaginator = client.get_paginator("describe_fleets")
  describe_image_builders_paginator: DescribeImageBuildersPaginator = client.get_paginator(
      "describe_image_builders"
  )
  describe_images_paginator: DescribeImagesPaginator = client.get_paginator("describe_images")
  describe_sessions_paginator: DescribeSessionsPaginator = client.get_paginator("describe_sessions")
  describe_stacks_paginator: DescribeStacksPaginator = client.get_paginator("describe_stacks")
  describe_user_stack_associations_paginator: DescribeUserStackAssociationsPaginator = (
      client.get_paginator("describe_user_stack_associations")
  )
  describe_users_paginator: DescribeUsersPaginator = client.get_paginator("describe_users")
  list_associated_fleets_paginator: ListAssociatedFleetsPaginator = client.get_paginator(
      "list_associated_fleets"
  )
  list_associated_stacks_paginator: ListAssociatedStacksPaginator = client.get_paginator(
      "list_associated_stacks"
  )
  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_appstream import AppStreamClient
  from types_boto3_appstream.waiter import FleetStartedWaiter, FleetStoppedWaiter

  client: AppStreamClient = Session().client("appstream")



  fleet_started_waiter: FleetStartedWaiter = client.get_waiter("fleet_started")
  fleet_stopped_waiter: FleetStoppedWaiter = client.get_waiter("fleet_stopped")
  ```

  <a id="literals"></a>



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

  Full list of `AppStream` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_appstream/literals/).

  ```python
  from types_boto3_appstream.literals import AccessEndpointTypeType


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

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



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

  Full list of `AppStream` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_appstream/type_defs/).

  ```python
  from types_boto3_appstream.type_defs import AccessEndpointTypeDef


  def get_value() -> AccessEndpointTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-appstream` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_appstream/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 10d2c54052853ad50f98a3fc15ac292e860cce5d37640cf3b1acd07528b2c4e7
name: python-types-boto3-backup-help
arch: noarch
version: 1.35.83
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-backup
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-backup-1.35.83-1.src.rpm
location_href: Packages/python-types-boto3-backup-help-1.35.83-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-backup"></a>



  [![PyPI - types-boto3-backup](https://img.shields.io/pypi/v/types-boto3-backup.svg?color=blue)](https://pypi.org/project/types-boto3-backup/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-backup.svg?color=blue)](https://pypi.org/project/types-boto3-backup/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-backup)](https://pypistats.org/packages/types-boto3-backup)

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

  Type annotations for [boto3 Backup 1.35.83](https://pypi.org/project/boto3/)
  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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-backup docs](https://youtype.github.io/types_boto3_docs/types_boto3_backup/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-backup](#types-boto3-backup)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.83' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `Backup` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `Backup`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `Backup` service.

  ```bash

  python -m pip install 'types-boto3[backup]'



  python -m pip install 'types-boto3-lite[backup]'


  python -m pip install types-boto3-backup
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-backup
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[backup]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backup]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[backup]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backup]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[backup]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[backup]` with services you use in your environment:

  ```bash
  python -m pip install 'types-boto3[backup]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[backup]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backup]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[backup]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backup]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-backup` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `BackupClient` provides annotations for `boto3.client("backup")`.

  ```python
  from boto3.session import Session

  from types_boto3_backup import BackupClient

  client: BackupClient = Session().client("backup")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_backup import BackupClient
  from types_boto3_backup.paginator import (
      ListBackupJobsPaginator,
      ListBackupPlanTemplatesPaginator,
      ListBackupPlanVersionsPaginator,
      ListBackupPlansPaginator,
      ListBackupSelectionsPaginator,
      ListBackupVaultsPaginator,
      ListCopyJobsPaginator,
      ListIndexedRecoveryPointsPaginator,
      ListLegalHoldsPaginator,
      ListProtectedResourcesByBackupVaultPaginator,
      ListProtectedResourcesPaginator,
      ListRecoveryPointsByBackupVaultPaginator,
      ListRecoveryPointsByLegalHoldPaginator,
      ListRecoveryPointsByResourcePaginator,
      ListRestoreJobsByProtectedResourcePaginator,
      ListRestoreJobsPaginator,
      ListRestoreTestingPlansPaginator,
      ListRestoreTestingSelectionsPaginator,
  )

  client: BackupClient = Session().client("backup")



  list_backup_jobs_paginator: ListBackupJobsPaginator = client.get_paginator("list_backup_jobs")
  list_backup_plan_templates_paginator: ListBackupPlanTemplatesPaginator = client.get_paginator(
      "list_backup_plan_templates"
  )
  list_backup_plan_versions_paginator: ListBackupPlanVersionsPaginator = client.get_paginator(
      "list_backup_plan_versions"
  )
  list_backup_plans_paginator: ListBackupPlansPaginator = client.get_paginator("list_backup_plans")
  list_backup_selections_paginator: ListBackupSelectionsPaginator = client.get_paginator(
      "list_backup_selections"
  )
  list_backup_vaults_paginator: ListBackupVaultsPaginator = client.get_paginator("list_backup_vaults")
  list_copy_jobs_paginator: ListCopyJobsPaginator = client.get_paginator("list_copy_jobs")
  list_indexed_recovery_points_paginator: ListIndexedRecoveryPointsPaginator = client.get_paginator(
      "list_indexed_recovery_points"
  )
  list_legal_holds_paginator: ListLegalHoldsPaginator = client.get_paginator("list_legal_holds")
  list_protected_resources_by_backup_vault_paginator: ListProtectedResourcesByBackupVaultPaginator = (
      client.get_paginator("list_protected_resources_by_backup_vault")
  )
  list_protected_resources_paginator: ListProtectedResourcesPaginator = client.get_paginator(
      "list_protected_resources"
  )
  list_recovery_points_by_backup_vault_paginator: ListRecoveryPointsByBackupVaultPaginator = (
      client.get_paginator("list_recovery_points_by_backup_vault")
  )
  list_recovery_points_by_legal_hold_paginator: ListRecoveryPointsByLegalHoldPaginator = (
      client.get_paginator("list_recovery_points_by_legal_hold")
  )
  list_recovery_points_by_resource_paginator: ListRecoveryPointsByResourcePaginator = (
      client.get_paginator("list_recovery_points_by_resource")
  )
  list_restore_jobs_by_protected_resource_paginator: ListRestoreJobsByProtectedResourcePaginator = (
      client.get_paginator("list_restore_jobs_by_protected_resource")
  )
  list_restore_jobs_paginator: ListRestoreJobsPaginator = client.get_paginator("list_restore_jobs")
  list_restore_testing_plans_paginator: ListRestoreTestingPlansPaginator = client.get_paginator(
      "list_restore_testing_plans"
  )
  list_restore_testing_selections_paginator: ListRestoreTestingSelectionsPaginator = (
      client.get_paginator("list_restore_testing_selections")
  )
  ```

  <a id="literals"></a>



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

  Full list of `Backup` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_backup/literals/).

  ```python
  from types_boto3_backup.literals import AggregationPeriodType


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

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



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

  Full list of `Backup` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_backup/type_defs/).

  ```python
  from types_boto3_backup.type_defs import AdvancedBackupSettingOutputTypeDef


  def get_value() -> AdvancedBackupSettingOutputTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-backup` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_backup/)

  <a id="support-and-contributing"></a>



  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.


pkgId: e6408baac6dc7d5bc5213d4f037f1652e12fee02d4b17df0308f96fa4ac7471d
name: python-types-boto3-backupsearch-help
arch: noarch
version: 1.35.83
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-backupsearch
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-backupsearch-1.35.83-1.src.rpm
location_href: Packages/python-types-boto3-backupsearch-help-1.35.83-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-backupsearch"></a>



  [![PyPI - types-boto3-backupsearch](https://img.shields.io/pypi/v/types-boto3-backupsearch.svg?color=blue)](https://pypi.org/project/types-boto3-backupsearch/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-backupsearch.svg?color=blue)](https://pypi.org/project/types-boto3-backupsearch/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-backupsearch)](https://pypistats.org/packages/types-boto3-backupsearch)

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

  Type annotations for
  [boto3 BackupSearch 1.35.83](https://pypi.org/project/boto3/) 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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-backupsearch docs](https://youtype.github.io/types_boto3_docs/types_boto3_backupsearch/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-backupsearch](#types-boto3-backupsearch)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.83' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `BackupSearch` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `BackupSearch`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `BackupSearch` service.

  ```bash

  python -m pip install 'types-boto3[backupsearch]'



  python -m pip install 'types-boto3-lite[backupsearch]'


  python -m pip install types-boto3-backupsearch
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-backupsearch
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[backupsearch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backupsearch]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[backupsearch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backupsearch]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[backupsearch]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[backupsearch]` with services you use in your
    environment:

  ```bash
  python -m pip install 'types-boto3[backupsearch]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[backupsearch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backupsearch]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[backupsearch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[backupsearch]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-backupsearch` dependency in production. However, there is an issue
  in `pylint` that it complains about undefined variables. To fix it, set all
  types to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `BackupSearchClient` provides annotations for `boto3.client("backupsearch")`.

  ```python
  from boto3.session import Session

  from types_boto3_backupsearch import BackupSearchClient

  client: BackupSearchClient = Session().client("backupsearch")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_backupsearch import BackupSearchClient
  from types_boto3_backupsearch.paginator import (
      ListSearchJobBackupsPaginator,
      ListSearchJobResultsPaginator,
      ListSearchJobsPaginator,
      ListSearchResultExportJobsPaginator,
  )

  client: BackupSearchClient = Session().client("backupsearch")



  list_search_job_backups_paginator: ListSearchJobBackupsPaginator = client.get_paginator(
      "list_search_job_backups"
  )
  list_search_job_results_paginator: ListSearchJobResultsPaginator = client.get_paginator(
      "list_search_job_results"
  )
  list_search_jobs_paginator: ListSearchJobsPaginator = client.get_paginator("list_search_jobs")
  list_search_result_export_jobs_paginator: ListSearchResultExportJobsPaginator = (
      client.get_paginator("list_search_result_export_jobs")
  )
  ```

  <a id="literals"></a>



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

  Full list of `BackupSearch` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_backupsearch/literals/).

  ```python
  from types_boto3_backupsearch.literals import ExportJobStatusType


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

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



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

  Full list of `BackupSearch` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_backupsearch/type_defs/).

  ```python
  from types_boto3_backupsearch.type_defs import BackupCreationTimeFilterOutputTypeDef


  def get_value() -> BackupCreationTimeFilterOutputTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-backupsearch` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_backupsearch/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 78685b08cee16570cf06e639c4684cbe21a01bd2d10a346e4625279d61a7204b
name: python-types-boto3-batch-help
arch: noarch
version: 1.35.83
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-batch
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-batch-1.35.83-1.src.rpm
location_href: Packages/python-types-boto3-batch-help-1.35.83-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-batch"></a>



  [![PyPI - types-boto3-batch](https://img.shields.io/pypi/v/types-boto3-batch.svg?color=blue)](https://pypi.org/project/types-boto3-batch/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-batch.svg?color=blue)](https://pypi.org/project/types-boto3-batch/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-batch)](https://pypistats.org/packages/types-boto3-batch)

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

  Type annotations for [boto3 Batch 1.35.83](https://pypi.org/project/boto3/)
  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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-batch docs](https://youtype.github.io/types_boto3_docs/types_boto3_batch/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-batch](#types-boto3-batch)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.83' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `Batch` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `Batch`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `Batch` service.

  ```bash

  python -m pip install 'types-boto3[batch]'



  python -m pip install 'types-boto3-lite[batch]'


  python -m pip install types-boto3-batch
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-batch
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[batch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[batch]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[batch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[batch]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[batch]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[batch]` with services you use in your environment:

  ```bash
  python -m pip install 'types-boto3[batch]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[batch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[batch]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[batch]` in your environment:

  ```bash
  python -m pip install 'types-boto3[batch]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-batch` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `BatchClient` provides annotations for `boto3.client("batch")`.

  ```python
  from boto3.session import Session

  from types_boto3_batch import BatchClient

  client: BatchClient = Session().client("batch")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_batch import BatchClient
  from types_boto3_batch.paginator import (
      DescribeComputeEnvironmentsPaginator,
      DescribeJobDefinitionsPaginator,
      DescribeJobQueuesPaginator,
      ListJobsPaginator,
      ListSchedulingPoliciesPaginator,
  )

  client: BatchClient = Session().client("batch")



  describe_compute_environments_paginator: DescribeComputeEnvironmentsPaginator = (
      client.get_paginator("describe_compute_environments")
  )
  describe_job_definitions_paginator: DescribeJobDefinitionsPaginator = client.get_paginator(
      "describe_job_definitions"
  )
  describe_job_queues_paginator: DescribeJobQueuesPaginator = client.get_paginator(
      "describe_job_queues"
  )
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
  list_scheduling_policies_paginator: ListSchedulingPoliciesPaginator = client.get_paginator(
      "list_scheduling_policies"
  )
  ```

  <a id="literals"></a>



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

  Full list of `Batch` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_batch/literals/).

  ```python
  from types_boto3_batch.literals import ArrayJobDependencyType


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

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



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

  Full list of `Batch` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_batch/type_defs/).

  ```python
  from types_boto3_batch.type_defs import ArrayPropertiesDetailTypeDef


  def get_value() -> ArrayPropertiesDetailTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-batch` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_batch/)

  <a id="support-and-contributing"></a>



  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.


pkgId: 1124980fdb2f80917b6ef705463b0102e187ac02bd5bf118ea13e359d722beb4
name: python-types-boto3-budgets-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for types-boto3-budgets
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-types-boto3-budgets-1.35.84-1.src.rpm
location_href: Packages/python-types-boto3-budgets-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="types-boto3-budgets"></a>



  [![PyPI - types-boto3-budgets](https://img.shields.io/pypi/v/types-boto3-budgets.svg?color=blue)](https://pypi.org/project/types-boto3-budgets/)
  [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/types-boto3-budgets.svg?color=blue)](https://pypi.org/project/types-boto3-budgets/)
  [![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/types_boto3_docs/)
  [![PyPI - Downloads](https://static.pepy.tech/badge/types-boto3-budgets)](https://pypistats.org/packages/types-boto3-budgets)

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

  Type annotations for [boto3 Budgets 1.35.84](https://pypi.org/project/boto3/)
  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 with
  [mypy-boto3-builder 8.6.4](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [types-boto3](https://pypi.org/project/types-boto3/) page and in
  [types-boto3-budgets docs](https://youtype.github.io/types_boto3_docs/types_boto3_budgets/).

  See how it helps you find and fix potential bugs:

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

  - [types-boto3-budgets](#types-boto3-budgets)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [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)
      - [Pylint compatibility](#pylint-compatibility)
    - [Explicit type annotations](#explicit-type-annotations)
      - [Client annotations](#client-annotations)
      - [Paginators annotations](#paginators-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>



  <a id="generate-locally-(recommended)"></a>



  You can generate type annotations for `boto3` package locally with
  `mypy_boto3_builder`. Use
  [uv](https://docs.astral.sh/uv/getting-started/installation/) for build
  isolation.

  1. Run mypy-boto3-builder in your package root directory:
     `uvx --with 'boto3==1.35.84' mypy_boto3_builder`
  2. Select `boto3` AWS SDK.
  3. Add `Budgets` service.
  4. Use provided commands to install generated packages.

  <a id="vscode-extension"></a>



  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 `Budgets`.

  <a id="from-pypi-with-pip"></a>



  Install `types-boto3` for `Budgets` service.

  ```bash

  python -m pip install 'types-boto3[budgets]'



  python -m pip install 'types-boto3-lite[budgets]'


  python -m pip install types-boto3-budgets
  ```

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



  ```bash
  python -m pip uninstall -y types-boto3-budgets
  ```

  <a id="usage"></a>



  <a id="vscode"></a>



  - 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-boto3[budgets]` in your environment:

  ```bash
  python -m pip install 'types-boto3[budgets]'
  ```

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

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



  > ⚠️ Due to slow PyCharm performance on `Literal` overloads (issue
  > [PY-40997](https://youtrack.jetbrains.com/issue/PY-40997)), it is recommended
  > to use [types-boto3-lite](https://pypi.org/project/types-boto3-lite/) until
  > the issue is resolved.

  > ⚠️ If you experience slow performance and high CPU usage, try to disable
  > `PyCharm` type checker and use [mypy](https://github.com/python/mypy) or
  > [pyright](https://github.com/microsoft/pyright) instead.

  > ⚠️ To continue using `PyCharm` type checker, you can try to replace
  > `types-boto3` with
  > [types-boto3-lite](https://pypi.org/project/types-boto3-lite/):

  ```bash
  pip uninstall types-boto3
  pip install types-boto3-lite
  ```

  Install `types-boto3[budgets]` in your environment:

  ```bash
  python -m pip install 'types-boto3[budgets]'
  ```

  Both type checking and code completion should now work.

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



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

  ```bash
  python -m pip install 'types-boto3[budgets]'
  ```

  - 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-boto3`

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

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



  - Install `types-boto3[budgets]` with services you use in your environment:

  ```bash
  python -m pip install 'types-boto3[budgets]'
  ```

  - 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>



  Not tested, but as long as your IDE supports `mypy` or `pyright`, everything
  should work.

  <a id="mypy"></a>



  - Install `mypy`: `python -m pip install mypy`
  - Install `types-boto3[budgets]` in your environment:

  ```bash
  python -m pip install 'types-boto3[budgets]'
  ```

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

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



  - Install `pyright`: `npm i -g pyright`
  - Install `types-boto3[budgets]` in your environment:

  ```bash
  python -m pip install 'types-boto3[budgets]'
  ```

  Optionally, you can install `types-boto3` to `typings` directory.

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

  <a id="pylint-compatibility"></a>



  It is totally safe to use `TYPE_CHECKING` flag in order to avoid
  `types-boto3-budgets` dependency in production. However, there is an issue in
  `pylint` that it complains about undefined variables. To fix it, set all types
  to `object` in non-`TYPE_CHECKING` mode.

  ```python
  from typing import TYPE_CHECKING

  if TYPE_CHECKING:
      from types_boto3_ec2 import EC2Client, EC2ServiceResource
      from types_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from types_boto3_ec2.paginators import DescribeVolumesPaginator
  else:
      EC2Client = object
      EC2ServiceResource = object
      BundleTaskCompleteWaiter = object
      DescribeVolumesPaginator = object

  ...
  ```

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



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



  `BudgetsClient` provides annotations for `boto3.client("budgets")`.

  ```python
  from boto3.session import Session

  from types_boto3_budgets import BudgetsClient

  client: BudgetsClient = Session().client("budgets")


  ```

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



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

  ```python
  from boto3.session import Session

  from types_boto3_budgets import BudgetsClient
  from types_boto3_budgets.paginator import (
      DescribeBudgetActionHistoriesPaginator,
      DescribeBudgetActionsForAccountPaginator,
      DescribeBudgetActionsForBudgetPaginator,
      DescribeBudgetNotificationsForAccountPaginator,
      DescribeBudgetPerformanceHistoryPaginator,
      DescribeBudgetsPaginator,
      DescribeNotificationsForBudgetPaginator,
      DescribeSubscribersForNotificationPaginator,
  )

  client: BudgetsClient = Session().client("budgets")



  describe_budget_action_histories_paginator: DescribeBudgetActionHistoriesPaginator = (
      client.get_paginator("describe_budget_action_histories")
  )
  describe_budget_actions_for_account_paginator: DescribeBudgetActionsForAccountPaginator = (
      client.get_paginator("describe_budget_actions_for_account")
  )
  describe_budget_actions_for_budget_paginator: DescribeBudgetActionsForBudgetPaginator = (
      client.get_paginator("describe_budget_actions_for_budget")
  )
  describe_budget_notifications_for_account_paginator: DescribeBudgetNotificationsForAccountPaginator = client.get_paginator(
      "describe_budget_notifications_for_account"
  )
  describe_budget_performance_history_paginator: DescribeBudgetPerformanceHistoryPaginator = (
      client.get_paginator("describe_budget_performance_history")
  )
  describe_budgets_paginator: DescribeBudgetsPaginator = client.get_paginator("describe_budgets")
  describe_notifications_for_budget_paginator: DescribeNotificationsForBudgetPaginator = (
      client.get_paginator("describe_notifications_for_budget")
  )
  describe_subscribers_for_notification_paginator: DescribeSubscribersForNotificationPaginator = (
      client.get_paginator("describe_subscribers_for_notification")
  )
  ```

  <a id="literals"></a>



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

  Full list of `Budgets` Literals can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_budgets/literals/).

  ```python
  from types_boto3_budgets.literals import ActionStatusType


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

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



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

  Full list of `Budgets` TypeDefs can be found in
  [docs](https://youtype.github.io/types_boto3_docs/types_boto3_budgets/type_defs/).

  ```python
  from types_boto3_budgets.type_defs import ActionThresholdTypeDef


  def get_value() -> ActionThresholdTypeDef:
      return {...}
  ```

  <a id="how-it-works"></a>



  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 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 `botocore` schemas.
  - Type annotations include up-to-date documentation.
  - Link to documentation is provided for every method.
  - Code is processed by [ruff](https://docs.astral.sh/ruff/) for readability.

  <a id="what's-new"></a>



  <a id="implemented-features"></a>



  - 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>



  Builder changelog can be found in
  [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

  <a id="versioning"></a>



  `types-boto3-budgets` 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>



  - [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>



  All services type annotations can be found in
  [boto3 docs](https://youtype.github.io/types_boto3_docs/types_boto3_budgets/)

  <a id="support-and-contributing"></a>



  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.


