# packages

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



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

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

  Type annotations for
  [boto3 ConnectParticipant 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-connectparticipant docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_connectparticipant/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-connectparticipant](#mypy-boto3-connectparticipant)
    - [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)
      - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `ConnectParticipant` 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 `ConnectParticipant`.

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



  Install `boto3-stubs` for `ConnectParticipant` service.

  ```bash

  python -m pip install 'boto3-stubs[connectparticipant]'



  python -m pip install 'boto3-stubs-lite[connectparticipant]'


  python -m pip install mypy-boto3-connectparticipant
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-connectparticipant
  ```

  <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 `boto3-stubs[connectparticipant]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[connectparticipant]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[connectparticipant]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[connectparticipant]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[connectparticipant]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[connectparticipant]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[connectparticipant]'
  ```

  - 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 `boto3-stubs[connectparticipant]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[connectparticipant]'
  ```

  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 `boto3-stubs[connectparticipant]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[connectparticipant]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-connectparticipant` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `ConnectParticipantClient` provides annotations for
  `boto3.client("connectparticipant")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_connectparticipant import ConnectParticipantClient

  client: ConnectParticipantClient = Session().client("connectparticipant")


  ```

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



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

  Full list of `ConnectParticipant` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_connectparticipant/literals/).

  ```python
  from mypy_boto3_connectparticipant.literals import ArtifactStatusType


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

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



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

  Full list of `ConnectParticipant` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_connectparticipant/type_defs/).

  ```python
  from mypy_boto3_connectparticipant.type_defs import AttachmentItemTypeDef


  def get_value() -> AttachmentItemTypeDef:
      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>



  `mypy-boto3-connectparticipant` 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/boto3_stubs_docs/mypy_boto3_connectparticipant/)

  <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: d7c7b983c9834294b2ba6264209a0b1722e57d396c2d4ae3c0f58f87cd9565b8
name: python-mypy-boto3-datasync-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-datasync
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-datasync-1.35.84-1.src.rpm
location_href: Packages/python-mypy-boto3-datasync-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-datasync"></a>



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

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

  Type annotations for [boto3 DataSync 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-datasync docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_datasync/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-datasync](#mypy-boto3-datasync)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `DataSync` 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 `DataSync`.

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



  Install `boto3-stubs` for `DataSync` service.

  ```bash

  python -m pip install 'boto3-stubs[datasync]'



  python -m pip install 'boto3-stubs-lite[datasync]'


  python -m pip install mypy-boto3-datasync
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-datasync
  ```

  <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 `boto3-stubs[datasync]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[datasync]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[datasync]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[datasync]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[datasync]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[datasync]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[datasync]'
  ```

  - 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 `boto3-stubs[datasync]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[datasync]'
  ```

  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 `boto3-stubs[datasync]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[datasync]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-datasync` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `DataSyncClient` provides annotations for `boto3.client("datasync")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_datasync import DataSyncClient

  client: DataSyncClient = Session().client("datasync")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_datasync import DataSyncClient
  from mypy_boto3_datasync.paginator import (
      DescribeStorageSystemResourceMetricsPaginator,
      ListAgentsPaginator,
      ListDiscoveryJobsPaginator,
      ListLocationsPaginator,
      ListStorageSystemsPaginator,
      ListTagsForResourcePaginator,
      ListTaskExecutionsPaginator,
      ListTasksPaginator,
  )

  client: DataSyncClient = Session().client("datasync")



  describe_storage_system_resource_metrics_paginator: DescribeStorageSystemResourceMetricsPaginator = client.get_paginator(
      "describe_storage_system_resource_metrics"
  )
  list_agents_paginator: ListAgentsPaginator = client.get_paginator("list_agents")
  list_discovery_jobs_paginator: ListDiscoveryJobsPaginator = client.get_paginator(
      "list_discovery_jobs"
  )
  list_locations_paginator: ListLocationsPaginator = client.get_paginator("list_locations")
  list_storage_systems_paginator: ListStorageSystemsPaginator = client.get_paginator(
      "list_storage_systems"
  )
  list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
      "list_tags_for_resource"
  )
  list_task_executions_paginator: ListTaskExecutionsPaginator = client.get_paginator(
      "list_task_executions"
  )
  list_tasks_paginator: ListTasksPaginator = client.get_paginator("list_tasks")
  ```

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



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

  Full list of `DataSync` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_datasync/literals/).

  ```python
  from mypy_boto3_datasync.literals import AgentStatusType


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

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



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

  Full list of `DataSync` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_datasync/type_defs/).

  ```python
  from mypy_boto3_datasync.type_defs import CredentialsTypeDef


  def get_value() -> CredentialsTypeDef:
      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>



  `mypy-boto3-datasync` 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/boto3_stubs_docs/mypy_boto3_datasync/)

  <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: b995d4debee320385eb41cdef3b3d31c94ad425f4763168911950b94072ce304
name: python-mypy-boto3-dlm-help
arch: noarch
version: 1.35.82
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-dlm
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-dlm-1.35.82-1.src.rpm
location_href: Packages/python-mypy-boto3-dlm-help-1.35.82-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-dlm"></a>



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

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

  Type annotations for [boto3 DLM 1.35.82](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-dlm docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dlm/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-dlm](#mypy-boto3-dlm)
    - [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)
      - [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.82' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `DLM` 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 `DLM`.

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



  Install `boto3-stubs` for `DLM` service.

  ```bash

  python -m pip install 'boto3-stubs[dlm]'



  python -m pip install 'boto3-stubs-lite[dlm]'


  python -m pip install mypy-boto3-dlm
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-dlm
  ```

  <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 `boto3-stubs[dlm]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[dlm]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[dlm]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[dlm]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[dlm]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[dlm]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[dlm]'
  ```

  - 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 `boto3-stubs[dlm]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[dlm]'
  ```

  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 `boto3-stubs[dlm]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[dlm]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-dlm` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `DLMClient` provides annotations for `boto3.client("dlm")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_dlm import DLMClient

  client: DLMClient = Session().client("dlm")


  ```

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



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

  Full list of `DLM` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dlm/literals/).

  ```python
  from mypy_boto3_dlm.literals import DefaultPoliciesTypeValuesType


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

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



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

  Full list of `DLM` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_dlm/type_defs/).

  ```python
  from mypy_boto3_dlm.type_defs import RetentionArchiveTierTypeDef


  def get_value() -> RetentionArchiveTierTypeDef:
      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>



  `mypy-boto3-dlm` 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/boto3_stubs_docs/mypy_boto3_dlm/)

  <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: 9b6b9eb532e7878b1f99d47a0604e01fe334e8c7c4bfd4a7a84ace49cfd7262d
name: python-mypy-boto3-ec2-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-ec2
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-ec2-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-ec2-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-ec2"></a>



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

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

  Type annotations for [boto3 EC2 1.35.81](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-ec2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-ec2](#mypy-boto3-ec2)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [VSCode extension](#vscode-extension)
      - [From PyPI with pip](#from-pypi-with-pip)
      - [From conda-forge](#from-conda-forge)
    - [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)
      - [Service Resource annotations](#service-resource-annotations)
      - [Other resources annotations](#other-resources-annotations)
      - [Collections annotations](#collections-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.81' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `EC2` 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 `EC2`.

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



  Install `boto3-stubs` for `EC2` service.

  ```bash

  python -m pip install 'boto3-stubs[ec2]'



  python -m pip install 'boto3-stubs-lite[ec2]'


  python -m pip install mypy-boto3-ec2
  ```

  <a id="from-conda-forge"></a>



  Add `conda-forge` to your channels with:

  ```bash
  conda config --add channels conda-forge
  conda config --set channel_priority strict
  ```

  Once the `conda-forge` channel has been enabled, `mypy-boto3-ec2` can be
  installed with:

  ```bash
  conda install mypy-boto3-ec2
  ```

  List all available versions of `mypy-boto3-ec2` available on your platform
  with:

  ```bash
  conda search mypy-boto3-ec2 --channel conda-forge
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-ec2
  ```

  <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 `boto3-stubs[ec2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ec2]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[ec2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ec2]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ec2]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[ec2]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ec2]'
  ```

  - 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 `boto3-stubs[ec2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ec2]'
  ```

  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 `boto3-stubs[ec2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ec2]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-ec2` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `EC2Client` provides annotations for `boto3.client("ec2")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_ec2 import EC2Client

  client: EC2Client = Session().client("ec2")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_ec2 import EC2Client
  from mypy_boto3_ec2.paginator import (
      DescribeAddressTransfersPaginator,
      DescribeAddressesAttributePaginator,
      DescribeAwsNetworkPerformanceMetricSubscriptionsPaginator,
      DescribeByoipCidrsPaginator,
      DescribeCapacityBlockExtensionHistoryPaginator,
      DescribeCapacityBlockExtensionOfferingsPaginator,
      DescribeCapacityBlockOfferingsPaginator,
      DescribeCapacityReservationBillingRequestsPaginator,
      DescribeCapacityReservationFleetsPaginator,
      DescribeCapacityReservationsPaginator,
      DescribeCarrierGatewaysPaginator,
      DescribeClassicLinkInstancesPaginator,
      DescribeClientVpnAuthorizationRulesPaginator,
      DescribeClientVpnConnectionsPaginator,
      DescribeClientVpnEndpointsPaginator,
      DescribeClientVpnRoutesPaginator,
      DescribeClientVpnTargetNetworksPaginator,
      DescribeCoipPoolsPaginator,
      DescribeDhcpOptionsPaginator,
      DescribeEgressOnlyInternetGatewaysPaginator,
      DescribeExportImageTasksPaginator,
      DescribeFastLaunchImagesPaginator,
      DescribeFastSnapshotRestoresPaginator,
      DescribeFleetsPaginator,
      DescribeFlowLogsPaginator,
      DescribeFpgaImagesPaginator,
      DescribeHostReservationOfferingsPaginator,
      DescribeHostReservationsPaginator,
      DescribeHostsPaginator,
      DescribeIamInstanceProfileAssociationsPaginator,
      DescribeImagesPaginator,
      DescribeImportImageTasksPaginator,
      DescribeImportSnapshotTasksPaginator,
      DescribeInstanceConnectEndpointsPaginator,
      DescribeInstanceCreditSpecificationsPaginator,
      DescribeInstanceEventWindowsPaginator,
      DescribeInstanceImageMetadataPaginator,
      DescribeInstanceStatusPaginator,
      DescribeInstanceTopologyPaginator,
      DescribeInstanceTypeOfferingsPaginator,
      DescribeInstanceTypesPaginator,
      DescribeInstancesPaginator,
      DescribeInternetGatewaysPaginator,
      DescribeIpamPoolsPaginator,
      DescribeIpamResourceDiscoveriesPaginator,
      DescribeIpamResourceDiscoveryAssociationsPaginator,
      DescribeIpamScopesPaginator,
      DescribeIpamsPaginator,
      DescribeIpv6PoolsPaginator,
      DescribeLaunchTemplateVersionsPaginator,
      DescribeLaunchTemplatesPaginator,
      DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator,
      DescribeLocalGatewayRouteTableVpcAssociationsPaginator,
      DescribeLocalGatewayRouteTablesPaginator,
      DescribeLocalGatewayVirtualInterfaceGroupsPaginator,
      DescribeLocalGatewayVirtualInterfacesPaginator,
      DescribeLocalGatewaysPaginator,
      DescribeMacHostsPaginator,
      DescribeManagedPrefixListsPaginator,
      DescribeMovingAddressesPaginator,
      DescribeNatGatewaysPaginator,
      DescribeNetworkAclsPaginator,
      DescribeNetworkInsightsAccessScopeAnalysesPaginator,
      DescribeNetworkInsightsAccessScopesPaginator,
      DescribeNetworkInsightsAnalysesPaginator,
      DescribeNetworkInsightsPathsPaginator,
      DescribeNetworkInterfacePermissionsPaginator,
      DescribeNetworkInterfacesPaginator,
      DescribePrefixListsPaginator,
      DescribePrincipalIdFormatPaginator,
      DescribePublicIpv4PoolsPaginator,
      DescribeReplaceRootVolumeTasksPaginator,
      DescribeReservedInstancesModificationsPaginator,
      DescribeReservedInstancesOfferingsPaginator,
      DescribeRouteTablesPaginator,
      DescribeScheduledInstanceAvailabilityPaginator,
      DescribeScheduledInstancesPaginator,
      DescribeSecurityGroupRulesPaginator,
      DescribeSecurityGroupVpcAssociationsPaginator,
      DescribeSecurityGroupsPaginator,
      DescribeSnapshotTierStatusPaginator,
      DescribeSnapshotsPaginator,
      DescribeSpotFleetInstancesPaginator,
      DescribeSpotFleetRequestsPaginator,
      DescribeSpotInstanceRequestsPaginator,
      DescribeSpotPriceHistoryPaginator,
      DescribeStaleSecurityGroupsPaginator,
      DescribeStoreImageTasksPaginator,
      DescribeSubnetsPaginator,
      DescribeTagsPaginator,
      DescribeTrafficMirrorFiltersPaginator,
      DescribeTrafficMirrorSessionsPaginator,
      DescribeTrafficMirrorTargetsPaginator,
      DescribeTransitGatewayAttachmentsPaginator,
      DescribeTransitGatewayConnectPeersPaginator,
      DescribeTransitGatewayConnectsPaginator,
      DescribeTransitGatewayMulticastDomainsPaginator,
      DescribeTransitGatewayPeeringAttachmentsPaginator,
      DescribeTransitGatewayPolicyTablesPaginator,
      DescribeTransitGatewayRouteTableAnnouncementsPaginator,
      DescribeTransitGatewayRouteTablesPaginator,
      DescribeTransitGatewayVpcAttachmentsPaginator,
      DescribeTransitGatewaysPaginator,
      DescribeTrunkInterfaceAssociationsPaginator,
      DescribeVerifiedAccessEndpointsPaginator,
      DescribeVerifiedAccessGroupsPaginator,
      DescribeVerifiedAccessInstanceLoggingConfigurationsPaginator,
      DescribeVerifiedAccessInstancesPaginator,
      DescribeVerifiedAccessTrustProvidersPaginator,
      DescribeVolumeStatusPaginator,
      DescribeVolumesModificationsPaginator,
      DescribeVolumesPaginator,
      DescribeVpcClassicLinkDnsSupportPaginator,
      DescribeVpcEndpointConnectionNotificationsPaginator,
      DescribeVpcEndpointConnectionsPaginator,
      DescribeVpcEndpointServiceConfigurationsPaginator,
      DescribeVpcEndpointServicePermissionsPaginator,
      DescribeVpcEndpointServicesPaginator,
      DescribeVpcEndpointsPaginator,
      DescribeVpcPeeringConnectionsPaginator,
      DescribeVpcsPaginator,
      GetAssociatedIpv6PoolCidrsPaginator,
      GetAwsNetworkPerformanceDataPaginator,
      GetGroupsForCapacityReservationPaginator,
      GetInstanceTypesFromInstanceRequirementsPaginator,
      GetIpamAddressHistoryPaginator,
      GetIpamDiscoveredAccountsPaginator,
      GetIpamDiscoveredResourceCidrsPaginator,
      GetIpamPoolAllocationsPaginator,
      GetIpamPoolCidrsPaginator,
      GetIpamResourceCidrsPaginator,
      GetManagedPrefixListAssociationsPaginator,
      GetManagedPrefixListEntriesPaginator,
      GetNetworkInsightsAccessScopeAnalysisFindingsPaginator,
      GetSecurityGroupsForVpcPaginator,
      GetSpotPlacementScoresPaginator,
      GetTransitGatewayAttachmentPropagationsPaginator,
      GetTransitGatewayMulticastDomainAssociationsPaginator,
      GetTransitGatewayPolicyTableAssociationsPaginator,
      GetTransitGatewayPrefixListReferencesPaginator,
      GetTransitGatewayRouteTableAssociationsPaginator,
      GetTransitGatewayRouteTablePropagationsPaginator,
      GetVpnConnectionDeviceTypesPaginator,
      ListImagesInRecycleBinPaginator,
      ListSnapshotsInRecycleBinPaginator,
      SearchLocalGatewayRoutesPaginator,
      SearchTransitGatewayMulticastGroupsPaginator,
  )

  client: EC2Client = Session().client("ec2")



  describe_address_transfers_paginator: DescribeAddressTransfersPaginator = client.get_paginator(
      "describe_address_transfers"
  )
  describe_addresses_attribute_paginator: DescribeAddressesAttributePaginator = client.get_paginator(
      "describe_addresses_attribute"
  )
  describe_aws_network_performance_metric_subscriptions_paginator: DescribeAwsNetworkPerformanceMetricSubscriptionsPaginator = client.get_paginator(
      "describe_aws_network_performance_metric_subscriptions"
  )
  describe_byoip_cidrs_paginator: DescribeByoipCidrsPaginator = client.get_paginator(
      "describe_byoip_cidrs"
  )
  describe_capacity_block_extension_history_paginator: DescribeCapacityBlockExtensionHistoryPaginator = client.get_paginator(
      "describe_capacity_block_extension_history"
  )
  describe_capacity_block_extension_offerings_paginator: DescribeCapacityBlockExtensionOfferingsPaginator = client.get_paginator(
      "describe_capacity_block_extension_offerings"
  )
  describe_capacity_block_offerings_paginator: DescribeCapacityBlockOfferingsPaginator = (
      client.get_paginator("describe_capacity_block_offerings")
  )
  describe_capacity_reservation_billing_requests_paginator: DescribeCapacityReservationBillingRequestsPaginator = client.get_paginator(
      "describe_capacity_reservation_billing_requests"
  )
  describe_capacity_reservation_fleets_paginator: DescribeCapacityReservationFleetsPaginator = (
      client.get_paginator("describe_capacity_reservation_fleets")
  )
  describe_capacity_reservations_paginator: DescribeCapacityReservationsPaginator = (
      client.get_paginator("describe_capacity_reservations")
  )
  describe_carrier_gateways_paginator: DescribeCarrierGatewaysPaginator = client.get_paginator(
      "describe_carrier_gateways"
  )
  describe_classic_link_instances_paginator: DescribeClassicLinkInstancesPaginator = (
      client.get_paginator("describe_classic_link_instances")
  )
  describe_client_vpn_authorization_rules_paginator: DescribeClientVpnAuthorizationRulesPaginator = (
      client.get_paginator("describe_client_vpn_authorization_rules")
  )
  describe_client_vpn_connections_paginator: DescribeClientVpnConnectionsPaginator = (
      client.get_paginator("describe_client_vpn_connections")
  )
  describe_client_vpn_endpoints_paginator: DescribeClientVpnEndpointsPaginator = client.get_paginator(
      "describe_client_vpn_endpoints"
  )
  describe_client_vpn_routes_paginator: DescribeClientVpnRoutesPaginator = client.get_paginator(
      "describe_client_vpn_routes"
  )
  describe_client_vpn_target_networks_paginator: DescribeClientVpnTargetNetworksPaginator = (
      client.get_paginator("describe_client_vpn_target_networks")
  )
  describe_coip_pools_paginator: DescribeCoipPoolsPaginator = client.get_paginator(
      "describe_coip_pools"
  )
  describe_dhcp_options_paginator: DescribeDhcpOptionsPaginator = client.get_paginator(
      "describe_dhcp_options"
  )
  describe_egress_only_internet_gateways_paginator: DescribeEgressOnlyInternetGatewaysPaginator = (
      client.get_paginator("describe_egress_only_internet_gateways")
  )
  describe_export_image_tasks_paginator: DescribeExportImageTasksPaginator = client.get_paginator(
      "describe_export_image_tasks"
  )
  describe_fast_launch_images_paginator: DescribeFastLaunchImagesPaginator = client.get_paginator(
      "describe_fast_launch_images"
  )
  describe_fast_snapshot_restores_paginator: DescribeFastSnapshotRestoresPaginator = (
      client.get_paginator("describe_fast_snapshot_restores")
  )
  describe_fleets_paginator: DescribeFleetsPaginator = client.get_paginator("describe_fleets")
  describe_flow_logs_paginator: DescribeFlowLogsPaginator = client.get_paginator("describe_flow_logs")
  describe_fpga_images_paginator: DescribeFpgaImagesPaginator = client.get_paginator(
      "describe_fpga_images"
  )
  describe_host_reservation_offerings_paginator: DescribeHostReservationOfferingsPaginator = (
      client.get_paginator("describe_host_reservation_offerings")
  )
  describe_host_reservations_paginator: DescribeHostReservationsPaginator = client.get_paginator(
      "describe_host_reservations"
  )
  describe_hosts_paginator: DescribeHostsPaginator = client.get_paginator("describe_hosts")
  describe_iam_instance_profile_associations_paginator: DescribeIamInstanceProfileAssociationsPaginator = client.get_paginator(
      "describe_iam_instance_profile_associations"
  )
  describe_images_paginator: DescribeImagesPaginator = client.get_paginator("describe_images")
  describe_import_image_tasks_paginator: DescribeImportImageTasksPaginator = client.get_paginator(
      "describe_import_image_tasks"
  )
  describe_import_snapshot_tasks_paginator: DescribeImportSnapshotTasksPaginator = (
      client.get_paginator("describe_import_snapshot_tasks")
  )
  describe_instance_connect_endpoints_paginator: DescribeInstanceConnectEndpointsPaginator = (
      client.get_paginator("describe_instance_connect_endpoints")
  )
  describe_instance_credit_specifications_paginator: DescribeInstanceCreditSpecificationsPaginator = (
      client.get_paginator("describe_instance_credit_specifications")
  )
  describe_instance_event_windows_paginator: DescribeInstanceEventWindowsPaginator = (
      client.get_paginator("describe_instance_event_windows")
  )
  describe_instance_image_metadata_paginator: DescribeInstanceImageMetadataPaginator = (
      client.get_paginator("describe_instance_image_metadata")
  )
  describe_instance_status_paginator: DescribeInstanceStatusPaginator = client.get_paginator(
      "describe_instance_status"
  )
  describe_instance_topology_paginator: DescribeInstanceTopologyPaginator = client.get_paginator(
      "describe_instance_topology"
  )
  describe_instance_type_offerings_paginator: DescribeInstanceTypeOfferingsPaginator = (
      client.get_paginator("describe_instance_type_offerings")
  )
  describe_instance_types_paginator: DescribeInstanceTypesPaginator = client.get_paginator(
      "describe_instance_types"
  )
  describe_instances_paginator: DescribeInstancesPaginator = client.get_paginator(
      "describe_instances"
  )
  describe_internet_gateways_paginator: DescribeInternetGatewaysPaginator = client.get_paginator(
      "describe_internet_gateways"
  )
  describe_ipam_pools_paginator: DescribeIpamPoolsPaginator = client.get_paginator(
      "describe_ipam_pools"
  )
  describe_ipam_resource_discoveries_paginator: DescribeIpamResourceDiscoveriesPaginator = (
      client.get_paginator("describe_ipam_resource_discoveries")
  )
  describe_ipam_resource_discovery_associations_paginator: DescribeIpamResourceDiscoveryAssociationsPaginator = client.get_paginator(
      "describe_ipam_resource_discovery_associations"
  )
  describe_ipam_scopes_paginator: DescribeIpamScopesPaginator = client.get_paginator(
      "describe_ipam_scopes"
  )
  describe_ipams_paginator: DescribeIpamsPaginator = client.get_paginator("describe_ipams")
  describe_ipv6_pools_paginator: DescribeIpv6PoolsPaginator = client.get_paginator(
      "describe_ipv6_pools"
  )
  describe_launch_template_versions_paginator: DescribeLaunchTemplateVersionsPaginator = (
      client.get_paginator("describe_launch_template_versions")
  )
  describe_launch_templates_paginator: DescribeLaunchTemplatesPaginator = client.get_paginator(
      "describe_launch_templates"
  )
  describe_local_gateway_route_table_virtual_interface_group_associations_paginator: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsPaginator = client.get_paginator(
      "describe_local_gateway_route_table_virtual_interface_group_associations"
  )
  describe_local_gateway_route_table_vpc_associations_paginator: DescribeLocalGatewayRouteTableVpcAssociationsPaginator = client.get_paginator(
      "describe_local_gateway_route_table_vpc_associations"
  )
  describe_local_gateway_route_tables_paginator: DescribeLocalGatewayRouteTablesPaginator = (
      client.get_paginator("describe_local_gateway_route_tables")
  )
  describe_local_gateway_virtual_interface_groups_paginator: DescribeLocalGatewayVirtualInterfaceGroupsPaginator = client.get_paginator(
      "describe_local_gateway_virtual_interface_groups"
  )
  describe_local_gateway_virtual_interfaces_paginator: DescribeLocalGatewayVirtualInterfacesPaginator = client.get_paginator(
      "describe_local_gateway_virtual_interfaces"
  )
  describe_local_gateways_paginator: DescribeLocalGatewaysPaginator = client.get_paginator(
      "describe_local_gateways"
  )
  describe_mac_hosts_paginator: DescribeMacHostsPaginator = client.get_paginator("describe_mac_hosts")
  describe_managed_prefix_lists_paginator: DescribeManagedPrefixListsPaginator = client.get_paginator(
      "describe_managed_prefix_lists"
  )
  describe_moving_addresses_paginator: DescribeMovingAddressesPaginator = client.get_paginator(
      "describe_moving_addresses"
  )
  describe_nat_gateways_paginator: DescribeNatGatewaysPaginator = client.get_paginator(
      "describe_nat_gateways"
  )
  describe_network_acls_paginator: DescribeNetworkAclsPaginator = client.get_paginator(
      "describe_network_acls"
  )
  describe_network_insights_access_scope_analyses_paginator: DescribeNetworkInsightsAccessScopeAnalysesPaginator = client.get_paginator(
      "describe_network_insights_access_scope_analyses"
  )
  describe_network_insights_access_scopes_paginator: DescribeNetworkInsightsAccessScopesPaginator = (
      client.get_paginator("describe_network_insights_access_scopes")
  )
  describe_network_insights_analyses_paginator: DescribeNetworkInsightsAnalysesPaginator = (
      client.get_paginator("describe_network_insights_analyses")
  )
  describe_network_insights_paths_paginator: DescribeNetworkInsightsPathsPaginator = (
      client.get_paginator("describe_network_insights_paths")
  )
  describe_network_interface_permissions_paginator: DescribeNetworkInterfacePermissionsPaginator = (
      client.get_paginator("describe_network_interface_permissions")
  )
  describe_network_interfaces_paginator: DescribeNetworkInterfacesPaginator = client.get_paginator(
      "describe_network_interfaces"
  )
  describe_prefix_lists_paginator: DescribePrefixListsPaginator = client.get_paginator(
      "describe_prefix_lists"
  )
  describe_principal_id_format_paginator: DescribePrincipalIdFormatPaginator = client.get_paginator(
      "describe_principal_id_format"
  )
  describe_public_ipv4_pools_paginator: DescribePublicIpv4PoolsPaginator = client.get_paginator(
      "describe_public_ipv4_pools"
  )
  describe_replace_root_volume_tasks_paginator: DescribeReplaceRootVolumeTasksPaginator = (
      client.get_paginator("describe_replace_root_volume_tasks")
  )
  describe_reserved_instances_modifications_paginator: DescribeReservedInstancesModificationsPaginator = client.get_paginator(
      "describe_reserved_instances_modifications"
  )
  describe_reserved_instances_offerings_paginator: DescribeReservedInstancesOfferingsPaginator = (
      client.get_paginator("describe_reserved_instances_offerings")
  )
  describe_route_tables_paginator: DescribeRouteTablesPaginator = client.get_paginator(
      "describe_route_tables"
  )
  describe_scheduled_instance_availability_paginator: DescribeScheduledInstanceAvailabilityPaginator = client.get_paginator(
      "describe_scheduled_instance_availability"
  )
  describe_scheduled_instances_paginator: DescribeScheduledInstancesPaginator = client.get_paginator(
      "describe_scheduled_instances"
  )
  describe_security_group_rules_paginator: DescribeSecurityGroupRulesPaginator = client.get_paginator(
      "describe_security_group_rules"
  )
  describe_security_group_vpc_associations_paginator: DescribeSecurityGroupVpcAssociationsPaginator = client.get_paginator(
      "describe_security_group_vpc_associations"
  )
  describe_security_groups_paginator: DescribeSecurityGroupsPaginator = client.get_paginator(
      "describe_security_groups"
  )
  describe_snapshot_tier_status_paginator: DescribeSnapshotTierStatusPaginator = client.get_paginator(
      "describe_snapshot_tier_status"
  )
  describe_snapshots_paginator: DescribeSnapshotsPaginator = client.get_paginator(
      "describe_snapshots"
  )
  describe_spot_fleet_instances_paginator: DescribeSpotFleetInstancesPaginator = client.get_paginator(
      "describe_spot_fleet_instances"
  )
  describe_spot_fleet_requests_paginator: DescribeSpotFleetRequestsPaginator = client.get_paginator(
      "describe_spot_fleet_requests"
  )
  describe_spot_instance_requests_paginator: DescribeSpotInstanceRequestsPaginator = (
      client.get_paginator("describe_spot_instance_requests")
  )
  describe_spot_price_history_paginator: DescribeSpotPriceHistoryPaginator = client.get_paginator(
      "describe_spot_price_history"
  )
  describe_stale_security_groups_paginator: DescribeStaleSecurityGroupsPaginator = (
      client.get_paginator("describe_stale_security_groups")
  )
  describe_store_image_tasks_paginator: DescribeStoreImageTasksPaginator = client.get_paginator(
      "describe_store_image_tasks"
  )
  describe_subnets_paginator: DescribeSubnetsPaginator = client.get_paginator("describe_subnets")
  describe_tags_paginator: DescribeTagsPaginator = client.get_paginator("describe_tags")
  describe_traffic_mirror_filters_paginator: DescribeTrafficMirrorFiltersPaginator = (
      client.get_paginator("describe_traffic_mirror_filters")
  )
  describe_traffic_mirror_sessions_paginator: DescribeTrafficMirrorSessionsPaginator = (
      client.get_paginator("describe_traffic_mirror_sessions")
  )
  describe_traffic_mirror_targets_paginator: DescribeTrafficMirrorTargetsPaginator = (
      client.get_paginator("describe_traffic_mirror_targets")
  )
  describe_transit_gateway_attachments_paginator: DescribeTransitGatewayAttachmentsPaginator = (
      client.get_paginator("describe_transit_gateway_attachments")
  )
  describe_transit_gateway_connect_peers_paginator: DescribeTransitGatewayConnectPeersPaginator = (
      client.get_paginator("describe_transit_gateway_connect_peers")
  )
  describe_transit_gateway_connects_paginator: DescribeTransitGatewayConnectsPaginator = (
      client.get_paginator("describe_transit_gateway_connects")
  )
  describe_transit_gateway_multicast_domains_paginator: DescribeTransitGatewayMulticastDomainsPaginator = client.get_paginator(
      "describe_transit_gateway_multicast_domains"
  )
  describe_transit_gateway_peering_attachments_paginator: DescribeTransitGatewayPeeringAttachmentsPaginator = client.get_paginator(
      "describe_transit_gateway_peering_attachments"
  )
  describe_transit_gateway_policy_tables_paginator: DescribeTransitGatewayPolicyTablesPaginator = (
      client.get_paginator("describe_transit_gateway_policy_tables")
  )
  describe_transit_gateway_route_table_announcements_paginator: DescribeTransitGatewayRouteTableAnnouncementsPaginator = client.get_paginator(
      "describe_transit_gateway_route_table_announcements"
  )
  describe_transit_gateway_route_tables_paginator: DescribeTransitGatewayRouteTablesPaginator = (
      client.get_paginator("describe_transit_gateway_route_tables")
  )
  describe_transit_gateway_vpc_attachments_paginator: DescribeTransitGatewayVpcAttachmentsPaginator = client.get_paginator(
      "describe_transit_gateway_vpc_attachments"
  )
  describe_transit_gateways_paginator: DescribeTransitGatewaysPaginator = client.get_paginator(
      "describe_transit_gateways"
  )
  describe_trunk_interface_associations_paginator: DescribeTrunkInterfaceAssociationsPaginator = (
      client.get_paginator("describe_trunk_interface_associations")
  )
  describe_verified_access_endpoints_paginator: DescribeVerifiedAccessEndpointsPaginator = (
      client.get_paginator("describe_verified_access_endpoints")
  )
  describe_verified_access_groups_paginator: DescribeVerifiedAccessGroupsPaginator = (
      client.get_paginator("describe_verified_access_groups")
  )
  describe_verified_access_instance_logging_configurations_paginator: DescribeVerifiedAccessInstanceLoggingConfigurationsPaginator = client.get_paginator(
      "describe_verified_access_instance_logging_configurations"
  )
  describe_verified_access_instances_paginator: DescribeVerifiedAccessInstancesPaginator = (
      client.get_paginator("describe_verified_access_instances")
  )
  describe_verified_access_trust_providers_paginator: DescribeVerifiedAccessTrustProvidersPaginator = client.get_paginator(
      "describe_verified_access_trust_providers"
  )
  describe_volume_status_paginator: DescribeVolumeStatusPaginator = client.get_paginator(
      "describe_volume_status"
  )
  describe_volumes_modifications_paginator: DescribeVolumesModificationsPaginator = (
      client.get_paginator("describe_volumes_modifications")
  )
  describe_volumes_paginator: DescribeVolumesPaginator = client.get_paginator("describe_volumes")
  describe_vpc_classic_link_dns_support_paginator: DescribeVpcClassicLinkDnsSupportPaginator = (
      client.get_paginator("describe_vpc_classic_link_dns_support")
  )
  describe_vpc_endpoint_connection_notifications_paginator: DescribeVpcEndpointConnectionNotificationsPaginator = client.get_paginator(
      "describe_vpc_endpoint_connection_notifications"
  )
  describe_vpc_endpoint_connections_paginator: DescribeVpcEndpointConnectionsPaginator = (
      client.get_paginator("describe_vpc_endpoint_connections")
  )
  describe_vpc_endpoint_service_configurations_paginator: DescribeVpcEndpointServiceConfigurationsPaginator = client.get_paginator(
      "describe_vpc_endpoint_service_configurations"
  )
  describe_vpc_endpoint_service_permissions_paginator: DescribeVpcEndpointServicePermissionsPaginator = client.get_paginator(
      "describe_vpc_endpoint_service_permissions"
  )
  describe_vpc_endpoint_services_paginator: DescribeVpcEndpointServicesPaginator = (
      client.get_paginator("describe_vpc_endpoint_services")
  )
  describe_vpc_endpoints_paginator: DescribeVpcEndpointsPaginator = client.get_paginator(
      "describe_vpc_endpoints"
  )
  describe_vpc_peering_connections_paginator: DescribeVpcPeeringConnectionsPaginator = (
      client.get_paginator("describe_vpc_peering_connections")
  )
  describe_vpcs_paginator: DescribeVpcsPaginator = client.get_paginator("describe_vpcs")
  get_associated_ipv6_pool_cidrs_paginator: GetAssociatedIpv6PoolCidrsPaginator = (
      client.get_paginator("get_associated_ipv6_pool_cidrs")
  )
  get_aws_network_performance_data_paginator: GetAwsNetworkPerformanceDataPaginator = (
      client.get_paginator("get_aws_network_performance_data")
  )
  get_groups_for_capacity_reservation_paginator: GetGroupsForCapacityReservationPaginator = (
      client.get_paginator("get_groups_for_capacity_reservation")
  )
  get_instance_types_from_instance_requirements_paginator: GetInstanceTypesFromInstanceRequirementsPaginator = client.get_paginator(
      "get_instance_types_from_instance_requirements"
  )
  get_ipam_address_history_paginator: GetIpamAddressHistoryPaginator = client.get_paginator(
      "get_ipam_address_history"
  )
  get_ipam_discovered_accounts_paginator: GetIpamDiscoveredAccountsPaginator = client.get_paginator(
      "get_ipam_discovered_accounts"
  )
  get_ipam_discovered_resource_cidrs_paginator: GetIpamDiscoveredResourceCidrsPaginator = (
      client.get_paginator("get_ipam_discovered_resource_cidrs")
  )
  get_ipam_pool_allocations_paginator: GetIpamPoolAllocationsPaginator = client.get_paginator(
      "get_ipam_pool_allocations"
  )
  get_ipam_pool_cidrs_paginator: GetIpamPoolCidrsPaginator = client.get_paginator(
      "get_ipam_pool_cidrs"
  )
  get_ipam_resource_cidrs_paginator: GetIpamResourceCidrsPaginator = client.get_paginator(
      "get_ipam_resource_cidrs"
  )
  get_managed_prefix_list_associations_paginator: GetManagedPrefixListAssociationsPaginator = (
      client.get_paginator("get_managed_prefix_list_associations")
  )
  get_managed_prefix_list_entries_paginator: GetManagedPrefixListEntriesPaginator = (
      client.get_paginator("get_managed_prefix_list_entries")
  )
  get_network_insights_access_scope_analysis_findings_paginator: GetNetworkInsightsAccessScopeAnalysisFindingsPaginator = client.get_paginator(
      "get_network_insights_access_scope_analysis_findings"
  )
  get_security_groups_for_vpc_paginator: GetSecurityGroupsForVpcPaginator = client.get_paginator(
      "get_security_groups_for_vpc"
  )
  get_spot_placement_scores_paginator: GetSpotPlacementScoresPaginator = client.get_paginator(
      "get_spot_placement_scores"
  )
  get_transit_gateway_attachment_propagations_paginator: GetTransitGatewayAttachmentPropagationsPaginator = client.get_paginator(
      "get_transit_gateway_attachment_propagations"
  )
  get_transit_gateway_multicast_domain_associations_paginator: GetTransitGatewayMulticastDomainAssociationsPaginator = client.get_paginator(
      "get_transit_gateway_multicast_domain_associations"
  )
  get_transit_gateway_policy_table_associations_paginator: GetTransitGatewayPolicyTableAssociationsPaginator = client.get_paginator(
      "get_transit_gateway_policy_table_associations"
  )
  get_transit_gateway_prefix_list_references_paginator: GetTransitGatewayPrefixListReferencesPaginator = client.get_paginator(
      "get_transit_gateway_prefix_list_references"
  )
  get_transit_gateway_route_table_associations_paginator: GetTransitGatewayRouteTableAssociationsPaginator = client.get_paginator(
      "get_transit_gateway_route_table_associations"
  )
  get_transit_gateway_route_table_propagations_paginator: GetTransitGatewayRouteTablePropagationsPaginator = client.get_paginator(
      "get_transit_gateway_route_table_propagations"
  )
  get_vpn_connection_device_types_paginator: GetVpnConnectionDeviceTypesPaginator = (
      client.get_paginator("get_vpn_connection_device_types")
  )
  list_images_in_recycle_bin_paginator: ListImagesInRecycleBinPaginator = client.get_paginator(
      "list_images_in_recycle_bin"
  )
  list_snapshots_in_recycle_bin_paginator: ListSnapshotsInRecycleBinPaginator = client.get_paginator(
      "list_snapshots_in_recycle_bin"
  )
  search_local_gateway_routes_paginator: SearchLocalGatewayRoutesPaginator = client.get_paginator(
      "search_local_gateway_routes"
  )
  search_transit_gateway_multicast_groups_paginator: SearchTransitGatewayMulticastGroupsPaginator = (
      client.get_paginator("search_transit_gateway_multicast_groups")
  )
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_ec2 import EC2Client
  from mypy_boto3_ec2.waiter import (
      BundleTaskCompleteWaiter,
      ConversionTaskCancelledWaiter,
      ConversionTaskCompletedWaiter,
      ConversionTaskDeletedWaiter,
      CustomerGatewayAvailableWaiter,
      ExportTaskCancelledWaiter,
      ExportTaskCompletedWaiter,
      ImageAvailableWaiter,
      ImageExistsWaiter,
      InstanceExistsWaiter,
      InstanceRunningWaiter,
      InstanceStatusOkWaiter,
      InstanceStoppedWaiter,
      InstanceTerminatedWaiter,
      InternetGatewayExistsWaiter,
      KeyPairExistsWaiter,
      NatGatewayAvailableWaiter,
      NatGatewayDeletedWaiter,
      NetworkInterfaceAvailableWaiter,
      PasswordDataAvailableWaiter,
      SecurityGroupExistsWaiter,
      SnapshotCompletedWaiter,
      SnapshotImportedWaiter,
      SpotInstanceRequestFulfilledWaiter,
      StoreImageTaskCompleteWaiter,
      SubnetAvailableWaiter,
      SystemStatusOkWaiter,
      VolumeAvailableWaiter,
      VolumeDeletedWaiter,
      VolumeInUseWaiter,
      VpcAvailableWaiter,
      VpcExistsWaiter,
      VpcPeeringConnectionDeletedWaiter,
      VpcPeeringConnectionExistsWaiter,
      VpnConnectionAvailableWaiter,
      VpnConnectionDeletedWaiter,
  )

  client: EC2Client = Session().client("ec2")



  bundle_task_complete_waiter: BundleTaskCompleteWaiter = client.get_waiter("bundle_task_complete")
  conversion_task_cancelled_waiter: ConversionTaskCancelledWaiter = client.get_waiter(
      "conversion_task_cancelled"
  )
  conversion_task_completed_waiter: ConversionTaskCompletedWaiter = client.get_waiter(
      "conversion_task_completed"
  )
  conversion_task_deleted_waiter: ConversionTaskDeletedWaiter = client.get_waiter(
      "conversion_task_deleted"
  )
  customer_gateway_available_waiter: CustomerGatewayAvailableWaiter = client.get_waiter(
      "customer_gateway_available"
  )
  export_task_cancelled_waiter: ExportTaskCancelledWaiter = client.get_waiter("export_task_cancelled")
  export_task_completed_waiter: ExportTaskCompletedWaiter = client.get_waiter("export_task_completed")
  image_available_waiter: ImageAvailableWaiter = client.get_waiter("image_available")
  image_exists_waiter: ImageExistsWaiter = client.get_waiter("image_exists")
  instance_exists_waiter: InstanceExistsWaiter = client.get_waiter("instance_exists")
  instance_running_waiter: InstanceRunningWaiter = client.get_waiter("instance_running")
  instance_status_ok_waiter: InstanceStatusOkWaiter = client.get_waiter("instance_status_ok")
  instance_stopped_waiter: InstanceStoppedWaiter = client.get_waiter("instance_stopped")
  instance_terminated_waiter: InstanceTerminatedWaiter = client.get_waiter("instance_terminated")
  internet_gateway_exists_waiter: InternetGatewayExistsWaiter = client.get_waiter(
      "internet_gateway_exists"
  )
  key_pair_exists_waiter: KeyPairExistsWaiter = client.get_waiter("key_pair_exists")
  nat_gateway_available_waiter: NatGatewayAvailableWaiter = client.get_waiter("nat_gateway_available")
  nat_gateway_deleted_waiter: NatGatewayDeletedWaiter = client.get_waiter("nat_gateway_deleted")
  network_interface_available_waiter: NetworkInterfaceAvailableWaiter = client.get_waiter(
      "network_interface_available"
  )
  password_data_available_waiter: PasswordDataAvailableWaiter = client.get_waiter(
      "password_data_available"
  )
  security_group_exists_waiter: SecurityGroupExistsWaiter = client.get_waiter("security_group_exists")
  snapshot_completed_waiter: SnapshotCompletedWaiter = client.get_waiter("snapshot_completed")
  snapshot_imported_waiter: SnapshotImportedWaiter = client.get_waiter("snapshot_imported")
  spot_instance_request_fulfilled_waiter: SpotInstanceRequestFulfilledWaiter = client.get_waiter(
      "spot_instance_request_fulfilled"
  )
  store_image_task_complete_waiter: StoreImageTaskCompleteWaiter = client.get_waiter(
      "store_image_task_complete"
  )
  subnet_available_waiter: SubnetAvailableWaiter = client.get_waiter("subnet_available")
  system_status_ok_waiter: SystemStatusOkWaiter = client.get_waiter("system_status_ok")
  volume_available_waiter: VolumeAvailableWaiter = client.get_waiter("volume_available")
  volume_deleted_waiter: VolumeDeletedWaiter = client.get_waiter("volume_deleted")
  volume_in_use_waiter: VolumeInUseWaiter = client.get_waiter("volume_in_use")
  vpc_available_waiter: VpcAvailableWaiter = client.get_waiter("vpc_available")
  vpc_exists_waiter: VpcExistsWaiter = client.get_waiter("vpc_exists")
  vpc_peering_connection_deleted_waiter: VpcPeeringConnectionDeletedWaiter = client.get_waiter(
      "vpc_peering_connection_deleted"
  )
  vpc_peering_connection_exists_waiter: VpcPeeringConnectionExistsWaiter = client.get_waiter(
      "vpc_peering_connection_exists"
  )
  vpn_connection_available_waiter: VpnConnectionAvailableWaiter = client.get_waiter(
      "vpn_connection_available"
  )
  vpn_connection_deleted_waiter: VpnConnectionDeletedWaiter = client.get_waiter(
      "vpn_connection_deleted"
  )
  ```

  <a id="service-resource-annotations"></a>



  `EC2ServiceResource` provides annotations for `boto3.resource("ec2")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_ec2 import EC2ServiceResource

  resource: EC2ServiceResource = Session().resource("ec2")


  ```

  <a id="other-resources-annotations"></a>



  `mypy_boto3_ec2.service_resource` module contains type annotations for all
  resources.

  ```python
  from boto3.session import Session

  from mypy_boto3_ec2 import EC2ServiceResource
  from mypy_boto3_ec2.service_resource import (
      ClassicAddress,
      DhcpOptions,
      Image,
      Instance,
      InternetGateway,
      KeyPair,
      KeyPairInfo,
      NetworkAcl,
      NetworkInterface,
      NetworkInterfaceAssociation,
      PlacementGroup,
      Route,
      RouteTable,
      RouteTableAssociation,
      SecurityGroup,
      Snapshot,
      Subnet,
      Tag,
      Volume,
      Vpc,
      VpcPeeringConnection,
      VpcAddress,
  )

  resource: EC2ServiceResource = Session().resource("ec2")



  my_classic_address: ClassicAddress = resource.ClassicAddress(...)
  my_dhcp_options: DhcpOptions = resource.DhcpOptions(...)
  my_image: Image = resource.Image(...)
  my_instance: Instance = resource.Instance(...)
  my_internet_gateway: InternetGateway = resource.InternetGateway(...)
  my_key_pair: KeyPair = resource.KeyPair(...)
  my_key_pair_info: KeyPairInfo = resource.KeyPairInfo(...)
  my_network_acl: NetworkAcl = resource.NetworkAcl(...)
  my_network_interface: NetworkInterface = resource.NetworkInterface(...)
  my_network_interface_association: NetworkInterfaceAssociation = (
      resource.NetworkInterfaceAssociation(...)
  )
  my_placement_group: PlacementGroup = resource.PlacementGroup(...)
  my_route: Route = resource.Route(...)
  my_route_table: RouteTable = resource.RouteTable(...)
  my_route_table_association: RouteTableAssociation = resource.RouteTableAssociation(...)
  my_security_group: SecurityGroup = resource.SecurityGroup(...)
  my_snapshot: Snapshot = resource.Snapshot(...)
  my_subnet: Subnet = resource.Subnet(...)
  my_tag: Tag = resource.Tag(...)
  my_volume: Volume = resource.Volume(...)
  my_vpc: Vpc = resource.Vpc(...)
  my_vpc_peering_connection: VpcPeeringConnection = resource.VpcPeeringConnection(...)
  my_vpc_address: VpcAddress = resource.VpcAddress(...)
  ```

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



  `mypy_boto3_ec2.service_resource` module contains type annotations for all
  `EC2ServiceResource` collections.

  ```python
  from boto3.session import Session

  from mypy_boto3_ec2 import EC2ServiceResource
  from mypy_boto3_ec2.service_resource import (
      ServiceResourceClassicAddressesCollection,
      ServiceResourceDhcpOptionsSetsCollection,
      ServiceResourceImagesCollection,
      ServiceResourceInstancesCollection,
      ServiceResourceInternetGatewaysCollection,
      ServiceResourceKeyPairsCollection,
      ServiceResourceNetworkAclsCollection,
      ServiceResourceNetworkInterfacesCollection,
      ServiceResourcePlacementGroupsCollection,
      ServiceResourceRouteTablesCollection,
      ServiceResourceSecurityGroupsCollection,
      ServiceResourceSnapshotsCollection,
      ServiceResourceSubnetsCollection,
      ServiceResourceVolumesCollection,
      ServiceResourceVpcAddressesCollection,
      ServiceResourceVpcPeeringConnectionsCollection,
      ServiceResourceVpcsCollection,
  )

  resource: EC2ServiceResource = Session().resource("ec2")



  classic_addresses: ec2_resources.ServiceResourceClassicAddressesCollection = (
      resource.classic_addresses
  )
  dhcp_options_sets: ec2_resources.ServiceResourceDhcpOptionsSetsCollection = (
      resource.dhcp_options_sets
  )
  images: ec2_resources.ServiceResourceImagesCollection = resource.images
  instances: ec2_resources.ServiceResourceInstancesCollection = resource.instances
  internet_gateways: ec2_resources.ServiceResourceInternetGatewaysCollection = (
      resource.internet_gateways
  )
  key_pairs: ec2_resources.ServiceResourceKeyPairsCollection = resource.key_pairs
  network_acls: ec2_resources.ServiceResourceNetworkAclsCollection = resource.network_acls
  network_interfaces: ec2_resources.ServiceResourceNetworkInterfacesCollection = (
      resource.network_interfaces
  )
  placement_groups: ec2_resources.ServiceResourcePlacementGroupsCollection = resource.placement_groups
  route_tables: ec2_resources.ServiceResourceRouteTablesCollection = resource.route_tables
  security_groups: ec2_resources.ServiceResourceSecurityGroupsCollection = resource.security_groups
  snapshots: ec2_resources.ServiceResourceSnapshotsCollection = resource.snapshots
  subnets: ec2_resources.ServiceResourceSubnetsCollection = resource.subnets
  volumes: ec2_resources.ServiceResourceVolumesCollection = resource.volumes
  vpc_addresses: ec2_resources.ServiceResourceVpcAddressesCollection = resource.vpc_addresses
  vpc_peering_connections: ec2_resources.ServiceResourceVpcPeeringConnectionsCollection = (
      resource.vpc_peering_connections
  )
  vpcs: ec2_resources.ServiceResourceVpcsCollection = resource.vpcs
  ```

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



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

  Full list of `EC2` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/literals/).

  ```python
  from mypy_boto3_ec2.literals import AcceleratorManufacturerType


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

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



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

  Full list of `EC2` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ec2/type_defs/).

  ```python
  from mypy_boto3_ec2.type_defs import AcceleratorCountRequestTypeDef


  def get_value() -> AcceleratorCountRequestTypeDef:
      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>



  `mypy-boto3-ec2` 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/boto3_stubs_docs/mypy_boto3_ec2/)

  <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: f827a4b3ac4f8c58ab76bf092cc6e23f00dd876aa76526fb145af92e405253ae
name: python-mypy-boto3-ecs-help
arch: noarch
version: 1.35.83
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-ecs
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-ecs-1.35.83-1.src.rpm
location_href: Packages/python-mypy-boto3-ecs-help-1.35.83-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-ecs"></a>



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

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

  Type annotations for [boto3 ECS 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-ecs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ecs/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-ecs](#mypy-boto3-ecs)
    - [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.83' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `ECS` 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 `ECS`.

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



  Install `boto3-stubs` for `ECS` service.

  ```bash

  python -m pip install 'boto3-stubs[ecs]'



  python -m pip install 'boto3-stubs-lite[ecs]'


  python -m pip install mypy-boto3-ecs
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-ecs
  ```

  <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 `boto3-stubs[ecs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ecs]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[ecs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ecs]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ecs]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[ecs]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ecs]'
  ```

  - 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 `boto3-stubs[ecs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ecs]'
  ```

  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 `boto3-stubs[ecs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ecs]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-ecs` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `ECSClient` provides annotations for `boto3.client("ecs")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_ecs import ECSClient

  client: ECSClient = Session().client("ecs")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_ecs import ECSClient
  from mypy_boto3_ecs.paginator import (
      ListAccountSettingsPaginator,
      ListAttributesPaginator,
      ListClustersPaginator,
      ListContainerInstancesPaginator,
      ListServicesByNamespacePaginator,
      ListServicesPaginator,
      ListTaskDefinitionFamiliesPaginator,
      ListTaskDefinitionsPaginator,
      ListTasksPaginator,
  )

  client: ECSClient = Session().client("ecs")



  list_account_settings_paginator: ListAccountSettingsPaginator = client.get_paginator(
      "list_account_settings"
  )
  list_attributes_paginator: ListAttributesPaginator = client.get_paginator("list_attributes")
  list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
  list_container_instances_paginator: ListContainerInstancesPaginator = client.get_paginator(
      "list_container_instances"
  )
  list_services_by_namespace_paginator: ListServicesByNamespacePaginator = client.get_paginator(
      "list_services_by_namespace"
  )
  list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
  list_task_definition_families_paginator: ListTaskDefinitionFamiliesPaginator = client.get_paginator(
      "list_task_definition_families"
  )
  list_task_definitions_paginator: ListTaskDefinitionsPaginator = client.get_paginator(
      "list_task_definitions"
  )
  list_tasks_paginator: ListTasksPaginator = client.get_paginator("list_tasks")
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_ecs import ECSClient
  from mypy_boto3_ecs.waiter import (
      ServicesInactiveWaiter,
      ServicesStableWaiter,
      TasksRunningWaiter,
      TasksStoppedWaiter,
  )

  client: ECSClient = Session().client("ecs")



  services_inactive_waiter: ServicesInactiveWaiter = client.get_waiter("services_inactive")
  services_stable_waiter: ServicesStableWaiter = client.get_waiter("services_stable")
  tasks_running_waiter: TasksRunningWaiter = client.get_waiter("tasks_running")
  tasks_stopped_waiter: TasksStoppedWaiter = client.get_waiter("tasks_stopped")
  ```

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



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

  Full list of `ECS` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ecs/literals/).

  ```python
  from mypy_boto3_ecs.literals import AgentUpdateStatusType


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

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



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

  Full list of `ECS` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ecs/type_defs/).

  ```python
  from mypy_boto3_ecs.type_defs import AttachmentStateChangeTypeDef


  def get_value() -> AttachmentStateChangeTypeDef:
      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>



  `mypy-boto3-ecs` 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/boto3_stubs_docs/mypy_boto3_ecs/)

  <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: 9c19f998148db4b5eff17f599eb9c17ad35e669fb7961856ee21c3c22fabbe88
name: python-mypy-boto3-eks-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-eks
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-eks-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-eks-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-eks"></a>



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

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

  Type annotations for [boto3 EKS 1.35.81](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-eks docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_eks/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-eks](#mypy-boto3-eks)
    - [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.81' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `EKS` 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 `EKS`.

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



  Install `boto3-stubs` for `EKS` service.

  ```bash

  python -m pip install 'boto3-stubs[eks]'



  python -m pip install 'boto3-stubs-lite[eks]'


  python -m pip install mypy-boto3-eks
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-eks
  ```

  <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 `boto3-stubs[eks]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[eks]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[eks]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[eks]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[eks]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[eks]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[eks]'
  ```

  - 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 `boto3-stubs[eks]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[eks]'
  ```

  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 `boto3-stubs[eks]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[eks]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-eks` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `EKSClient` provides annotations for `boto3.client("eks")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_eks import EKSClient

  client: EKSClient = Session().client("eks")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_eks import EKSClient
  from mypy_boto3_eks.paginator import (
      DescribeAddonVersionsPaginator,
      ListAccessEntriesPaginator,
      ListAccessPoliciesPaginator,
      ListAddonsPaginator,
      ListAssociatedAccessPoliciesPaginator,
      ListClustersPaginator,
      ListEksAnywhereSubscriptionsPaginator,
      ListFargateProfilesPaginator,
      ListIdentityProviderConfigsPaginator,
      ListInsightsPaginator,
      ListNodegroupsPaginator,
      ListPodIdentityAssociationsPaginator,
      ListUpdatesPaginator,
  )

  client: EKSClient = Session().client("eks")



  describe_addon_versions_paginator: DescribeAddonVersionsPaginator = client.get_paginator(
      "describe_addon_versions"
  )
  list_access_entries_paginator: ListAccessEntriesPaginator = client.get_paginator(
      "list_access_entries"
  )
  list_access_policies_paginator: ListAccessPoliciesPaginator = client.get_paginator(
      "list_access_policies"
  )
  list_addons_paginator: ListAddonsPaginator = client.get_paginator("list_addons")
  list_associated_access_policies_paginator: ListAssociatedAccessPoliciesPaginator = (
      client.get_paginator("list_associated_access_policies")
  )
  list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
  list_eks_anywhere_subscriptions_paginator: ListEksAnywhereSubscriptionsPaginator = (
      client.get_paginator("list_eks_anywhere_subscriptions")
  )
  list_fargate_profiles_paginator: ListFargateProfilesPaginator = client.get_paginator(
      "list_fargate_profiles"
  )
  list_identity_provider_configs_paginator: ListIdentityProviderConfigsPaginator = (
      client.get_paginator("list_identity_provider_configs")
  )
  list_insights_paginator: ListInsightsPaginator = client.get_paginator("list_insights")
  list_nodegroups_paginator: ListNodegroupsPaginator = client.get_paginator("list_nodegroups")
  list_pod_identity_associations_paginator: ListPodIdentityAssociationsPaginator = (
      client.get_paginator("list_pod_identity_associations")
  )
  list_updates_paginator: ListUpdatesPaginator = client.get_paginator("list_updates")
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_eks import EKSClient
  from mypy_boto3_eks.waiter import (
      AddonActiveWaiter,
      AddonDeletedWaiter,
      ClusterActiveWaiter,
      ClusterDeletedWaiter,
      FargateProfileActiveWaiter,
      FargateProfileDeletedWaiter,
      NodegroupActiveWaiter,
      NodegroupDeletedWaiter,
  )

  client: EKSClient = Session().client("eks")



  addon_active_waiter: AddonActiveWaiter = client.get_waiter("addon_active")
  addon_deleted_waiter: AddonDeletedWaiter = client.get_waiter("addon_deleted")
  cluster_active_waiter: ClusterActiveWaiter = client.get_waiter("cluster_active")
  cluster_deleted_waiter: ClusterDeletedWaiter = client.get_waiter("cluster_deleted")
  fargate_profile_active_waiter: FargateProfileActiveWaiter = client.get_waiter(
      "fargate_profile_active"
  )
  fargate_profile_deleted_waiter: FargateProfileDeletedWaiter = client.get_waiter(
      "fargate_profile_deleted"
  )
  nodegroup_active_waiter: NodegroupActiveWaiter = client.get_waiter("nodegroup_active")
  nodegroup_deleted_waiter: NodegroupDeletedWaiter = client.get_waiter("nodegroup_deleted")
  ```

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



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

  Full list of `EKS` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_eks/literals/).

  ```python
  from mypy_boto3_eks.literals import AMITypesType


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

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



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

  Full list of `EKS` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_eks/type_defs/).

  ```python
  from mypy_boto3_eks.type_defs import AccessConfigResponseTypeDef


  def get_value() -> AccessConfigResponseTypeDef:
      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>



  `mypy-boto3-eks` 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/boto3_stubs_docs/mypy_boto3_eks/)

  <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: 2bcb5f1d13622f8bdb7bb50309dff75a1e5b942a438bc97040115b89f4fa3564
name: python-mypy-boto3-greengrassv2-help
arch: noarch
version: 1.35.82
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-greengrassv2
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-greengrassv2-1.35.82-1.src.rpm
location_href: Packages/python-mypy-boto3-greengrassv2-help-1.35.82-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-greengrassv2"></a>



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

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

  Type annotations for
  [boto3 GreengrassV2 1.35.82](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-greengrassv2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_greengrassv2/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-greengrassv2](#mypy-boto3-greengrassv2)
    - [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.82' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `GreengrassV2` 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 `GreengrassV2`.

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



  Install `boto3-stubs` for `GreengrassV2` service.

  ```bash

  python -m pip install 'boto3-stubs[greengrassv2]'



  python -m pip install 'boto3-stubs-lite[greengrassv2]'


  python -m pip install mypy-boto3-greengrassv2
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-greengrassv2
  ```

  <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 `boto3-stubs[greengrassv2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[greengrassv2]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[greengrassv2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[greengrassv2]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[greengrassv2]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[greengrassv2]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[greengrassv2]'
  ```

  - 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 `boto3-stubs[greengrassv2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[greengrassv2]'
  ```

  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 `boto3-stubs[greengrassv2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[greengrassv2]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-greengrassv2` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `GreengrassV2Client` provides annotations for `boto3.client("greengrassv2")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_greengrassv2 import GreengrassV2Client

  client: GreengrassV2Client = Session().client("greengrassv2")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_greengrassv2 import GreengrassV2Client
  from mypy_boto3_greengrassv2.paginator import (
      ListClientDevicesAssociatedWithCoreDevicePaginator,
      ListComponentVersionsPaginator,
      ListComponentsPaginator,
      ListCoreDevicesPaginator,
      ListDeploymentsPaginator,
      ListEffectiveDeploymentsPaginator,
      ListInstalledComponentsPaginator,
  )

  client: GreengrassV2Client = Session().client("greengrassv2")



  list_client_devices_associated_with_core_device_paginator: ListClientDevicesAssociatedWithCoreDevicePaginator = client.get_paginator(
      "list_client_devices_associated_with_core_device"
  )
  list_component_versions_paginator: ListComponentVersionsPaginator = client.get_paginator(
      "list_component_versions"
  )
  list_components_paginator: ListComponentsPaginator = client.get_paginator("list_components")
  list_core_devices_paginator: ListCoreDevicesPaginator = client.get_paginator("list_core_devices")
  list_deployments_paginator: ListDeploymentsPaginator = client.get_paginator("list_deployments")
  list_effective_deployments_paginator: ListEffectiveDeploymentsPaginator = client.get_paginator(
      "list_effective_deployments"
  )
  list_installed_components_paginator: ListInstalledComponentsPaginator = client.get_paginator(
      "list_installed_components"
  )
  ```

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



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

  Full list of `GreengrassV2` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_greengrassv2/literals/).

  ```python
  from mypy_boto3_greengrassv2.literals import CloudComponentStateType


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

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



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

  Full list of `GreengrassV2` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_greengrassv2/type_defs/).

  ```python
  from mypy_boto3_greengrassv2.type_defs import AssociateClientDeviceWithCoreDeviceEntryTypeDef


  def get_value() -> AssociateClientDeviceWithCoreDeviceEntryTypeDef:
      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>



  `mypy-boto3-greengrassv2` 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/boto3_stubs_docs/mypy_boto3_greengrassv2/)

  <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: c7ada60e8b07c99099e3c70b1f96d5b20c3b4da66e3effa357b4ae129c9785b3
name: python-mypy-boto3-iot-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-iot
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-iot-1.35.84-1.src.rpm
location_href: Packages/python-mypy-boto3-iot-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-iot"></a>



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

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

  Type annotations for [boto3 IoT 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-iot docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-iot](#mypy-boto3-iot)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `IoT` 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 `IoT`.

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



  Install `boto3-stubs` for `IoT` service.

  ```bash

  python -m pip install 'boto3-stubs[iot]'



  python -m pip install 'boto3-stubs-lite[iot]'


  python -m pip install mypy-boto3-iot
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-iot
  ```

  <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 `boto3-stubs[iot]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[iot]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[iot]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[iot]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[iot]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[iot]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[iot]'
  ```

  - 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 `boto3-stubs[iot]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[iot]'
  ```

  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 `boto3-stubs[iot]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[iot]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-iot` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `IoTClient` provides annotations for `boto3.client("iot")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_iot import IoTClient

  client: IoTClient = Session().client("iot")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_iot import IoTClient
  from mypy_boto3_iot.paginator import (
      GetBehaviorModelTrainingSummariesPaginator,
      ListActiveViolationsPaginator,
      ListAttachedPoliciesPaginator,
      ListAuditFindingsPaginator,
      ListAuditMitigationActionsExecutionsPaginator,
      ListAuditMitigationActionsTasksPaginator,
      ListAuditSuppressionsPaginator,
      ListAuditTasksPaginator,
      ListAuthorizersPaginator,
      ListBillingGroupsPaginator,
      ListCACertificatesPaginator,
      ListCertificatesByCAPaginator,
      ListCertificatesPaginator,
      ListCommandExecutionsPaginator,
      ListCommandsPaginator,
      ListCustomMetricsPaginator,
      ListDetectMitigationActionsExecutionsPaginator,
      ListDetectMitigationActionsTasksPaginator,
      ListDimensionsPaginator,
      ListDomainConfigurationsPaginator,
      ListFleetMetricsPaginator,
      ListIndicesPaginator,
      ListJobExecutionsForJobPaginator,
      ListJobExecutionsForThingPaginator,
      ListJobTemplatesPaginator,
      ListJobsPaginator,
      ListManagedJobTemplatesPaginator,
      ListMetricValuesPaginator,
      ListMitigationActionsPaginator,
      ListOTAUpdatesPaginator,
      ListOutgoingCertificatesPaginator,
      ListPackageVersionsPaginator,
      ListPackagesPaginator,
      ListPoliciesPaginator,
      ListPolicyPrincipalsPaginator,
      ListPrincipalPoliciesPaginator,
      ListPrincipalThingsPaginator,
      ListPrincipalThingsV2Paginator,
      ListProvisioningTemplateVersionsPaginator,
      ListProvisioningTemplatesPaginator,
      ListRelatedResourcesForAuditFindingPaginator,
      ListRoleAliasesPaginator,
      ListSbomValidationResultsPaginator,
      ListScheduledAuditsPaginator,
      ListSecurityProfilesForTargetPaginator,
      ListSecurityProfilesPaginator,
      ListStreamsPaginator,
      ListTagsForResourcePaginator,
      ListTargetsForPolicyPaginator,
      ListTargetsForSecurityProfilePaginator,
      ListThingGroupsForThingPaginator,
      ListThingGroupsPaginator,
      ListThingPrincipalsPaginator,
      ListThingPrincipalsV2Paginator,
      ListThingRegistrationTaskReportsPaginator,
      ListThingRegistrationTasksPaginator,
      ListThingTypesPaginator,
      ListThingsInBillingGroupPaginator,
      ListThingsInThingGroupPaginator,
      ListThingsPaginator,
      ListTopicRuleDestinationsPaginator,
      ListTopicRulesPaginator,
      ListV2LoggingLevelsPaginator,
      ListViolationEventsPaginator,
  )

  client: IoTClient = Session().client("iot")



  get_behavior_model_training_summaries_paginator: GetBehaviorModelTrainingSummariesPaginator = (
      client.get_paginator("get_behavior_model_training_summaries")
  )
  list_active_violations_paginator: ListActiveViolationsPaginator = client.get_paginator(
      "list_active_violations"
  )
  list_attached_policies_paginator: ListAttachedPoliciesPaginator = client.get_paginator(
      "list_attached_policies"
  )
  list_audit_findings_paginator: ListAuditFindingsPaginator = client.get_paginator(
      "list_audit_findings"
  )
  list_audit_mitigation_actions_executions_paginator: ListAuditMitigationActionsExecutionsPaginator = client.get_paginator(
      "list_audit_mitigation_actions_executions"
  )
  list_audit_mitigation_actions_tasks_paginator: ListAuditMitigationActionsTasksPaginator = (
      client.get_paginator("list_audit_mitigation_actions_tasks")
  )
  list_audit_suppressions_paginator: ListAuditSuppressionsPaginator = client.get_paginator(
      "list_audit_suppressions"
  )
  list_audit_tasks_paginator: ListAuditTasksPaginator = client.get_paginator("list_audit_tasks")
  list_authorizers_paginator: ListAuthorizersPaginator = client.get_paginator("list_authorizers")
  list_billing_groups_paginator: ListBillingGroupsPaginator = client.get_paginator(
      "list_billing_groups"
  )
  list_ca_certificates_paginator: ListCACertificatesPaginator = client.get_paginator(
      "list_ca_certificates"
  )
  list_certificates_by_ca_paginator: ListCertificatesByCAPaginator = client.get_paginator(
      "list_certificates_by_ca"
  )
  list_certificates_paginator: ListCertificatesPaginator = client.get_paginator("list_certificates")
  list_command_executions_paginator: ListCommandExecutionsPaginator = client.get_paginator(
      "list_command_executions"
  )
  list_commands_paginator: ListCommandsPaginator = client.get_paginator("list_commands")
  list_custom_metrics_paginator: ListCustomMetricsPaginator = client.get_paginator(
      "list_custom_metrics"
  )
  list_detect_mitigation_actions_executions_paginator: ListDetectMitigationActionsExecutionsPaginator = client.get_paginator(
      "list_detect_mitigation_actions_executions"
  )
  list_detect_mitigation_actions_tasks_paginator: ListDetectMitigationActionsTasksPaginator = (
      client.get_paginator("list_detect_mitigation_actions_tasks")
  )
  list_dimensions_paginator: ListDimensionsPaginator = client.get_paginator("list_dimensions")
  list_domain_configurations_paginator: ListDomainConfigurationsPaginator = client.get_paginator(
      "list_domain_configurations"
  )
  list_fleet_metrics_paginator: ListFleetMetricsPaginator = client.get_paginator("list_fleet_metrics")
  list_indices_paginator: ListIndicesPaginator = client.get_paginator("list_indices")
  list_job_executions_for_job_paginator: ListJobExecutionsForJobPaginator = client.get_paginator(
      "list_job_executions_for_job"
  )
  list_job_executions_for_thing_paginator: ListJobExecutionsForThingPaginator = client.get_paginator(
      "list_job_executions_for_thing"
  )
  list_job_templates_paginator: ListJobTemplatesPaginator = client.get_paginator("list_job_templates")
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
  list_managed_job_templates_paginator: ListManagedJobTemplatesPaginator = client.get_paginator(
      "list_managed_job_templates"
  )
  list_metric_values_paginator: ListMetricValuesPaginator = client.get_paginator("list_metric_values")
  list_mitigation_actions_paginator: ListMitigationActionsPaginator = client.get_paginator(
      "list_mitigation_actions"
  )
  list_ota_updates_paginator: ListOTAUpdatesPaginator = client.get_paginator("list_ota_updates")
  list_outgoing_certificates_paginator: ListOutgoingCertificatesPaginator = client.get_paginator(
      "list_outgoing_certificates"
  )
  list_package_versions_paginator: ListPackageVersionsPaginator = client.get_paginator(
      "list_package_versions"
  )
  list_packages_paginator: ListPackagesPaginator = client.get_paginator("list_packages")
  list_policies_paginator: ListPoliciesPaginator = client.get_paginator("list_policies")
  list_policy_principals_paginator: ListPolicyPrincipalsPaginator = client.get_paginator(
      "list_policy_principals"
  )
  list_principal_policies_paginator: ListPrincipalPoliciesPaginator = client.get_paginator(
      "list_principal_policies"
  )
  list_principal_things_paginator: ListPrincipalThingsPaginator = client.get_paginator(
      "list_principal_things"
  )
  list_principal_things_v2_paginator: ListPrincipalThingsV2Paginator = client.get_paginator(
      "list_principal_things_v2"
  )
  list_provisioning_template_versions_paginator: ListProvisioningTemplateVersionsPaginator = (
      client.get_paginator("list_provisioning_template_versions")
  )
  list_provisioning_templates_paginator: ListProvisioningTemplatesPaginator = client.get_paginator(
      "list_provisioning_templates"
  )
  list_related_resources_for_audit_finding_paginator: ListRelatedResourcesForAuditFindingPaginator = (
      client.get_paginator("list_related_resources_for_audit_finding")
  )
  list_role_aliases_paginator: ListRoleAliasesPaginator = client.get_paginator("list_role_aliases")
  list_sbom_validation_results_paginator: ListSbomValidationResultsPaginator = client.get_paginator(
      "list_sbom_validation_results"
  )
  list_scheduled_audits_paginator: ListScheduledAuditsPaginator = client.get_paginator(
      "list_scheduled_audits"
  )
  list_security_profiles_for_target_paginator: ListSecurityProfilesForTargetPaginator = (
      client.get_paginator("list_security_profiles_for_target")
  )
  list_security_profiles_paginator: ListSecurityProfilesPaginator = client.get_paginator(
      "list_security_profiles"
  )
  list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams")
  list_tags_for_resource_paginator: ListTagsForResourcePaginator = client.get_paginator(
      "list_tags_for_resource"
  )
  list_targets_for_policy_paginator: ListTargetsForPolicyPaginator = client.get_paginator(
      "list_targets_for_policy"
  )
  list_targets_for_security_profile_paginator: ListTargetsForSecurityProfilePaginator = (
      client.get_paginator("list_targets_for_security_profile")
  )
  list_thing_groups_for_thing_paginator: ListThingGroupsForThingPaginator = client.get_paginator(
      "list_thing_groups_for_thing"
  )
  list_thing_groups_paginator: ListThingGroupsPaginator = client.get_paginator("list_thing_groups")
  list_thing_principals_paginator: ListThingPrincipalsPaginator = client.get_paginator(
      "list_thing_principals"
  )
  list_thing_principals_v2_paginator: ListThingPrincipalsV2Paginator = client.get_paginator(
      "list_thing_principals_v2"
  )
  list_thing_registration_task_reports_paginator: ListThingRegistrationTaskReportsPaginator = (
      client.get_paginator("list_thing_registration_task_reports")
  )
  list_thing_registration_tasks_paginator: ListThingRegistrationTasksPaginator = client.get_paginator(
      "list_thing_registration_tasks"
  )
  list_thing_types_paginator: ListThingTypesPaginator = client.get_paginator("list_thing_types")
  list_things_in_billing_group_paginator: ListThingsInBillingGroupPaginator = client.get_paginator(
      "list_things_in_billing_group"
  )
  list_things_in_thing_group_paginator: ListThingsInThingGroupPaginator = client.get_paginator(
      "list_things_in_thing_group"
  )
  list_things_paginator: ListThingsPaginator = client.get_paginator("list_things")
  list_topic_rule_destinations_paginator: ListTopicRuleDestinationsPaginator = client.get_paginator(
      "list_topic_rule_destinations"
  )
  list_topic_rules_paginator: ListTopicRulesPaginator = client.get_paginator("list_topic_rules")
  list_v2_logging_levels_paginator: ListV2LoggingLevelsPaginator = client.get_paginator(
      "list_v2_logging_levels"
  )
  list_violation_events_paginator: ListViolationEventsPaginator = client.get_paginator(
      "list_violation_events"
  )
  ```

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



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

  Full list of `IoT` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/literals/).

  ```python
  from mypy_boto3_iot.literals import AbortActionType


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

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



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

  Full list of `IoT` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_iot/type_defs/).

  ```python
  from mypy_boto3_iot.type_defs import AbortCriteriaTypeDef


  def get_value() -> AbortCriteriaTypeDef:
      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>



  `mypy-boto3-iot` 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/boto3_stubs_docs/mypy_boto3_iot/)

  <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: e42255d6b526ea0677efee93e92aa62133155a47ebf5dd1e1994602205c61e85
name: python-mypy-boto3-logs-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-logs
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-logs-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-logs-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-logs"></a>



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

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

  Type annotations for
  [boto3 CloudWatchLogs 1.35.81](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-logs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_logs/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-logs](#mypy-boto3-logs)
    - [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.81' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `CloudWatchLogs` 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 `CloudWatchLogs`.

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



  Install `boto3-stubs` for `CloudWatchLogs` service.

  ```bash

  python -m pip install 'boto3-stubs[logs]'



  python -m pip install 'boto3-stubs-lite[logs]'


  python -m pip install mypy-boto3-logs
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-logs
  ```

  <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 `boto3-stubs[logs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[logs]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[logs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[logs]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[logs]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[logs]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[logs]'
  ```

  - 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 `boto3-stubs[logs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[logs]'
  ```

  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 `boto3-stubs[logs]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[logs]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-logs` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `CloudWatchLogsClient` provides annotations for `boto3.client("logs")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_logs import CloudWatchLogsClient

  client: CloudWatchLogsClient = Session().client("logs")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_logs import CloudWatchLogsClient
  from mypy_boto3_logs.paginator import (
      DescribeConfigurationTemplatesPaginator,
      DescribeDeliveriesPaginator,
      DescribeDeliveryDestinationsPaginator,
      DescribeDeliverySourcesPaginator,
      DescribeDestinationsPaginator,
      DescribeExportTasksPaginator,
      DescribeLogGroupsPaginator,
      DescribeLogStreamsPaginator,
      DescribeMetricFiltersPaginator,
      DescribeQueriesPaginator,
      DescribeResourcePoliciesPaginator,
      DescribeSubscriptionFiltersPaginator,
      FilterLogEventsPaginator,
      ListAnomaliesPaginator,
      ListLogAnomalyDetectorsPaginator,
      ListLogGroupsForQueryPaginator,
  )

  client: CloudWatchLogsClient = Session().client("logs")



  describe_configuration_templates_paginator: DescribeConfigurationTemplatesPaginator = (
      client.get_paginator("describe_configuration_templates")
  )
  describe_deliveries_paginator: DescribeDeliveriesPaginator = client.get_paginator(
      "describe_deliveries"
  )
  describe_delivery_destinations_paginator: DescribeDeliveryDestinationsPaginator = (
      client.get_paginator("describe_delivery_destinations")
  )
  describe_delivery_sources_paginator: DescribeDeliverySourcesPaginator = client.get_paginator(
      "describe_delivery_sources"
  )
  describe_destinations_paginator: DescribeDestinationsPaginator = client.get_paginator(
      "describe_destinations"
  )
  describe_export_tasks_paginator: DescribeExportTasksPaginator = client.get_paginator(
      "describe_export_tasks"
  )
  describe_log_groups_paginator: DescribeLogGroupsPaginator = client.get_paginator(
      "describe_log_groups"
  )
  describe_log_streams_paginator: DescribeLogStreamsPaginator = client.get_paginator(
      "describe_log_streams"
  )
  describe_metric_filters_paginator: DescribeMetricFiltersPaginator = client.get_paginator(
      "describe_metric_filters"
  )
  describe_queries_paginator: DescribeQueriesPaginator = client.get_paginator("describe_queries")
  describe_resource_policies_paginator: DescribeResourcePoliciesPaginator = client.get_paginator(
      "describe_resource_policies"
  )
  describe_subscription_filters_paginator: DescribeSubscriptionFiltersPaginator = (
      client.get_paginator("describe_subscription_filters")
  )
  filter_log_events_paginator: FilterLogEventsPaginator = client.get_paginator("filter_log_events")
  list_anomalies_paginator: ListAnomaliesPaginator = client.get_paginator("list_anomalies")
  list_log_anomaly_detectors_paginator: ListLogAnomalyDetectorsPaginator = client.get_paginator(
      "list_log_anomaly_detectors"
  )
  list_log_groups_for_query_paginator: ListLogGroupsForQueryPaginator = client.get_paginator(
      "list_log_groups_for_query"
  )
  ```

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



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

  Full list of `CloudWatchLogs` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_logs/literals/).

  ```python
  from mypy_boto3_logs.literals import AnomalyDetectorStatusType


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

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



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

  Full list of `CloudWatchLogs` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_logs/type_defs/).

  ```python
  from mypy_boto3_logs.type_defs import AccountPolicyTypeDef


  def get_value() -> AccountPolicyTypeDef:
      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>



  `mypy-boto3-logs` 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/boto3_stubs_docs/mypy_boto3_logs/)

  <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: 7e43de601d065cabb488fafcb7813b2c9c80b07c67c0e7458298f34d0a0c76ce
name: python-mypy-boto3-m2-help
arch: noarch
version: 1.35.83
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-m2
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-m2-1.35.83-1.src.rpm
location_href: Packages/python-mypy-boto3-m2-help-1.35.83-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-m2"></a>



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

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

  Type annotations for
  [boto3 MainframeModernization 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-m2 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_m2/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-m2](#mypy-boto3-m2)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `MainframeModernization` 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 `MainframeModernization`.

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



  Install `boto3-stubs` for `MainframeModernization` service.

  ```bash

  python -m pip install 'boto3-stubs[m2]'



  python -m pip install 'boto3-stubs-lite[m2]'


  python -m pip install mypy-boto3-m2
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-m2
  ```

  <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 `boto3-stubs[m2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[m2]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[m2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[m2]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[m2]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[m2]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[m2]'
  ```

  - 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 `boto3-stubs[m2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[m2]'
  ```

  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 `boto3-stubs[m2]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[m2]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-m2` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `MainframeModernizationClient` provides annotations for `boto3.client("m2")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_m2 import MainframeModernizationClient

  client: MainframeModernizationClient = Session().client("m2")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_m2 import MainframeModernizationClient
  from mypy_boto3_m2.paginator import (
      ListApplicationVersionsPaginator,
      ListApplicationsPaginator,
      ListBatchJobDefinitionsPaginator,
      ListBatchJobExecutionsPaginator,
      ListDataSetImportHistoryPaginator,
      ListDataSetsPaginator,
      ListDeploymentsPaginator,
      ListEngineVersionsPaginator,
      ListEnvironmentsPaginator,
  )

  client: MainframeModernizationClient = Session().client("m2")



  list_application_versions_paginator: ListApplicationVersionsPaginator = client.get_paginator(
      "list_application_versions"
  )
  list_applications_paginator: ListApplicationsPaginator = client.get_paginator("list_applications")
  list_batch_job_definitions_paginator: ListBatchJobDefinitionsPaginator = client.get_paginator(
      "list_batch_job_definitions"
  )
  list_batch_job_executions_paginator: ListBatchJobExecutionsPaginator = client.get_paginator(
      "list_batch_job_executions"
  )
  list_data_set_import_history_paginator: ListDataSetImportHistoryPaginator = client.get_paginator(
      "list_data_set_import_history"
  )
  list_data_sets_paginator: ListDataSetsPaginator = client.get_paginator("list_data_sets")
  list_deployments_paginator: ListDeploymentsPaginator = client.get_paginator("list_deployments")
  list_engine_versions_paginator: ListEngineVersionsPaginator = client.get_paginator(
      "list_engine_versions"
  )
  list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator("list_environments")
  ```

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



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

  Full list of `MainframeModernization` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_m2/literals/).

  ```python
  from mypy_boto3_m2.literals import ApplicationDeploymentLifecycleType


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

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



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

  Full list of `MainframeModernization` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_m2/type_defs/).

  ```python
  from mypy_boto3_m2.type_defs import AlternateKeyTypeDef


  def get_value() -> AlternateKeyTypeDef:
      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>



  `mypy-boto3-m2` 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/boto3_stubs_docs/mypy_boto3_m2/)

  <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: 9952925638bae8a388a672f9cf6de061039847dbcf4db8e044fdabc9ec12f956
name: python-mypy-boto3-mediaconnect-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-mediaconnect
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-mediaconnect-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-mediaconnect-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-mediaconnect"></a>



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

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

  Type annotations for
  [boto3 MediaConnect 1.35.81](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-mediaconnect docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mediaconnect/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-mediaconnect](#mypy-boto3-mediaconnect)
    - [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.81' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `MediaConnect` 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 `MediaConnect`.

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



  Install `boto3-stubs` for `MediaConnect` service.

  ```bash

  python -m pip install 'boto3-stubs[mediaconnect]'



  python -m pip install 'boto3-stubs-lite[mediaconnect]'


  python -m pip install mypy-boto3-mediaconnect
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-mediaconnect
  ```

  <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 `boto3-stubs[mediaconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconnect]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[mediaconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconnect]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconnect]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[mediaconnect]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconnect]'
  ```

  - 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 `boto3-stubs[mediaconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconnect]'
  ```

  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 `boto3-stubs[mediaconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconnect]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-mediaconnect` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `MediaConnectClient` provides annotations for `boto3.client("mediaconnect")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_mediaconnect import MediaConnectClient

  client: MediaConnectClient = Session().client("mediaconnect")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_mediaconnect import MediaConnectClient
  from mypy_boto3_mediaconnect.paginator import (
      ListBridgesPaginator,
      ListEntitlementsPaginator,
      ListFlowsPaginator,
      ListGatewayInstancesPaginator,
      ListGatewaysPaginator,
      ListOfferingsPaginator,
      ListReservationsPaginator,
  )

  client: MediaConnectClient = Session().client("mediaconnect")



  list_bridges_paginator: ListBridgesPaginator = client.get_paginator("list_bridges")
  list_entitlements_paginator: ListEntitlementsPaginator = client.get_paginator("list_entitlements")
  list_flows_paginator: ListFlowsPaginator = client.get_paginator("list_flows")
  list_gateway_instances_paginator: ListGatewayInstancesPaginator = client.get_paginator(
      "list_gateway_instances"
  )
  list_gateways_paginator: ListGatewaysPaginator = client.get_paginator("list_gateways")
  list_offerings_paginator: ListOfferingsPaginator = client.get_paginator("list_offerings")
  list_reservations_paginator: ListReservationsPaginator = client.get_paginator("list_reservations")
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_mediaconnect import MediaConnectClient
  from mypy_boto3_mediaconnect.waiter import FlowActiveWaiter, FlowDeletedWaiter, FlowStandbyWaiter

  client: MediaConnectClient = Session().client("mediaconnect")



  flow_active_waiter: FlowActiveWaiter = client.get_waiter("flow_active")
  flow_deleted_waiter: FlowDeletedWaiter = client.get_waiter("flow_deleted")
  flow_standby_waiter: FlowStandbyWaiter = client.get_waiter("flow_standby")
  ```

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



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

  Full list of `MediaConnect` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mediaconnect/literals/).

  ```python
  from mypy_boto3_mediaconnect.literals import AlgorithmType


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

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



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

  Full list of `MediaConnect` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mediaconnect/type_defs/).

  ```python
  from mypy_boto3_mediaconnect.type_defs import VpcInterfaceAttachmentTypeDef


  def get_value() -> VpcInterfaceAttachmentTypeDef:
      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>



  `mypy-boto3-mediaconnect` 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/boto3_stubs_docs/mypy_boto3_mediaconnect/)

  <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: 56b0406a81377e0fbc90bd86cfeb4d3a226c9953348024ca532894d50c84a58b
name: python-mypy-boto3-mediaconvert-help
arch: noarch
version: 1.35.85
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-mediaconvert
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-mediaconvert-1.35.85-1.src.rpm
location_href: Packages/python-mypy-boto3-mediaconvert-help-1.35.85-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-mediaconvert"></a>



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

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

  Type annotations for
  [boto3 MediaConvert 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-mediaconvert docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mediaconvert/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-mediaconvert](#mypy-boto3-mediaconvert)
    - [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.85' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `MediaConvert` 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 `MediaConvert`.

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



  Install `boto3-stubs` for `MediaConvert` service.

  ```bash

  python -m pip install 'boto3-stubs[mediaconvert]'



  python -m pip install 'boto3-stubs-lite[mediaconvert]'


  python -m pip install mypy-boto3-mediaconvert
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-mediaconvert
  ```

  <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 `boto3-stubs[mediaconvert]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconvert]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[mediaconvert]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconvert]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconvert]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[mediaconvert]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconvert]'
  ```

  - 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 `boto3-stubs[mediaconvert]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconvert]'
  ```

  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 `boto3-stubs[mediaconvert]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mediaconvert]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-mediaconvert` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `MediaConvertClient` provides annotations for `boto3.client("mediaconvert")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_mediaconvert import MediaConvertClient

  client: MediaConvertClient = Session().client("mediaconvert")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_mediaconvert import MediaConvertClient
  from mypy_boto3_mediaconvert.paginator import (
      DescribeEndpointsPaginator,
      ListJobTemplatesPaginator,
      ListJobsPaginator,
      ListPresetsPaginator,
      ListQueuesPaginator,
      ListVersionsPaginator,
      SearchJobsPaginator,
  )

  client: MediaConvertClient = Session().client("mediaconvert")



  describe_endpoints_paginator: DescribeEndpointsPaginator = client.get_paginator(
      "describe_endpoints"
  )
  list_job_templates_paginator: ListJobTemplatesPaginator = client.get_paginator("list_job_templates")
  list_jobs_paginator: ListJobsPaginator = client.get_paginator("list_jobs")
  list_presets_paginator: ListPresetsPaginator = client.get_paginator("list_presets")
  list_queues_paginator: ListQueuesPaginator = client.get_paginator("list_queues")
  list_versions_paginator: ListVersionsPaginator = client.get_paginator("list_versions")
  search_jobs_paginator: SearchJobsPaginator = client.get_paginator("search_jobs")
  ```

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



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

  Full list of `MediaConvert` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mediaconvert/literals/).

  ```python
  from mypy_boto3_mediaconvert.literals import AacAudioDescriptionBroadcasterMixType


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

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



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

  Full list of `MediaConvert` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mediaconvert/type_defs/).

  ```python
  from mypy_boto3_mediaconvert.type_defs import AacSettingsTypeDef


  def get_value() -> AacSettingsTypeDef:
      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>



  `mypy-boto3-mediaconvert` 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/boto3_stubs_docs/mypy_boto3_mediaconvert/)

  <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: c4e6b873ab24dd510a5bf49221aa55714057992d2722f4a56380064e62de1efb
name: python-mypy-boto3-medialive-help
arch: noarch
version: 1.35.82
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-medialive
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-medialive-1.35.82-1.src.rpm
location_href: Packages/python-mypy-boto3-medialive-help-1.35.82-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-medialive"></a>



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

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

  Type annotations for [boto3 MediaLive 1.35.82](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-medialive docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_medialive/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-medialive](#mypy-boto3-medialive)
    - [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.82' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `MediaLive` 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 `MediaLive`.

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



  Install `boto3-stubs` for `MediaLive` service.

  ```bash

  python -m pip install 'boto3-stubs[medialive]'



  python -m pip install 'boto3-stubs-lite[medialive]'


  python -m pip install mypy-boto3-medialive
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-medialive
  ```

  <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 `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[medialive]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  - 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 `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  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 `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-medialive` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `MediaLiveClient` provides annotations for `boto3.client("medialive")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_medialive import MediaLiveClient

  client: MediaLiveClient = Session().client("medialive")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_medialive import MediaLiveClient
  from mypy_boto3_medialive.paginator import (
      DescribeSchedulePaginator,
      ListChannelPlacementGroupsPaginator,
      ListChannelsPaginator,
      ListCloudWatchAlarmTemplateGroupsPaginator,
      ListCloudWatchAlarmTemplatesPaginator,
      ListClustersPaginator,
      ListEventBridgeRuleTemplateGroupsPaginator,
      ListEventBridgeRuleTemplatesPaginator,
      ListInputDeviceTransfersPaginator,
      ListInputDevicesPaginator,
      ListInputSecurityGroupsPaginator,
      ListInputsPaginator,
      ListMultiplexProgramsPaginator,
      ListMultiplexesPaginator,
      ListNetworksPaginator,
      ListNodesPaginator,
      ListOfferingsPaginator,
      ListReservationsPaginator,
      ListSignalMapsPaginator,
  )

  client: MediaLiveClient = Session().client("medialive")



  describe_schedule_paginator: DescribeSchedulePaginator = client.get_paginator("describe_schedule")
  list_channel_placement_groups_paginator: ListChannelPlacementGroupsPaginator = client.get_paginator(
      "list_channel_placement_groups"
  )
  list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
  list_cloud_watch_alarm_template_groups_paginator: ListCloudWatchAlarmTemplateGroupsPaginator = (
      client.get_paginator("list_cloud_watch_alarm_template_groups")
  )
  list_cloud_watch_alarm_templates_paginator: ListCloudWatchAlarmTemplatesPaginator = (
      client.get_paginator("list_cloud_watch_alarm_templates")
  )
  list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
  list_event_bridge_rule_template_groups_paginator: ListEventBridgeRuleTemplateGroupsPaginator = (
      client.get_paginator("list_event_bridge_rule_template_groups")
  )
  list_event_bridge_rule_templates_paginator: ListEventBridgeRuleTemplatesPaginator = (
      client.get_paginator("list_event_bridge_rule_templates")
  )
  list_input_device_transfers_paginator: ListInputDeviceTransfersPaginator = client.get_paginator(
      "list_input_device_transfers"
  )
  list_input_devices_paginator: ListInputDevicesPaginator = client.get_paginator("list_input_devices")
  list_input_security_groups_paginator: ListInputSecurityGroupsPaginator = client.get_paginator(
      "list_input_security_groups"
  )
  list_inputs_paginator: ListInputsPaginator = client.get_paginator("list_inputs")
  list_multiplex_programs_paginator: ListMultiplexProgramsPaginator = client.get_paginator(
      "list_multiplex_programs"
  )
  list_multiplexes_paginator: ListMultiplexesPaginator = client.get_paginator("list_multiplexes")
  list_networks_paginator: ListNetworksPaginator = client.get_paginator("list_networks")
  list_nodes_paginator: ListNodesPaginator = client.get_paginator("list_nodes")
  list_offerings_paginator: ListOfferingsPaginator = client.get_paginator("list_offerings")
  list_reservations_paginator: ListReservationsPaginator = client.get_paginator("list_reservations")
  list_signal_maps_paginator: ListSignalMapsPaginator = client.get_paginator("list_signal_maps")
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_medialive import MediaLiveClient
  from mypy_boto3_medialive.waiter import (
      ChannelCreatedWaiter,
      ChannelDeletedWaiter,
      ChannelPlacementGroupAssignedWaiter,
      ChannelPlacementGroupDeletedWaiter,
      ChannelPlacementGroupUnassignedWaiter,
      ChannelRunningWaiter,
      ChannelStoppedWaiter,
      ClusterCreatedWaiter,
      ClusterDeletedWaiter,
      InputAttachedWaiter,
      InputDeletedWaiter,
      InputDetachedWaiter,
      MultiplexCreatedWaiter,
      MultiplexDeletedWaiter,
      MultiplexRunningWaiter,
      MultiplexStoppedWaiter,
      NodeDeregisteredWaiter,
      NodeRegisteredWaiter,
      SignalMapCreatedWaiter,
      SignalMapMonitorDeletedWaiter,
      SignalMapMonitorDeployedWaiter,
      SignalMapUpdatedWaiter,
  )

  client: MediaLiveClient = Session().client("medialive")



  channel_created_waiter: ChannelCreatedWaiter = client.get_waiter("channel_created")
  channel_deleted_waiter: ChannelDeletedWaiter = client.get_waiter("channel_deleted")
  channel_placement_group_assigned_waiter: ChannelPlacementGroupAssignedWaiter = client.get_waiter(
      "channel_placement_group_assigned"
  )
  channel_placement_group_deleted_waiter: ChannelPlacementGroupDeletedWaiter = client.get_waiter(
      "channel_placement_group_deleted"
  )
  channel_placement_group_unassigned_waiter: ChannelPlacementGroupUnassignedWaiter = (
      client.get_waiter("channel_placement_group_unassigned")
  )
  channel_running_waiter: ChannelRunningWaiter = client.get_waiter("channel_running")
  channel_stopped_waiter: ChannelStoppedWaiter = client.get_waiter("channel_stopped")
  cluster_created_waiter: ClusterCreatedWaiter = client.get_waiter("cluster_created")
  cluster_deleted_waiter: ClusterDeletedWaiter = client.get_waiter("cluster_deleted")
  input_attached_waiter: InputAttachedWaiter = client.get_waiter("input_attached")
  input_deleted_waiter: InputDeletedWaiter = client.get_waiter("input_deleted")
  input_detached_waiter: InputDetachedWaiter = client.get_waiter("input_detached")
  multiplex_created_waiter: MultiplexCreatedWaiter = client.get_waiter("multiplex_created")
  multiplex_deleted_waiter: MultiplexDeletedWaiter = client.get_waiter("multiplex_deleted")
  multiplex_running_waiter: MultiplexRunningWaiter = client.get_waiter("multiplex_running")
  multiplex_stopped_waiter: MultiplexStoppedWaiter = client.get_waiter("multiplex_stopped")
  node_deregistered_waiter: NodeDeregisteredWaiter = client.get_waiter("node_deregistered")
  node_registered_waiter: NodeRegisteredWaiter = client.get_waiter("node_registered")
  signal_map_created_waiter: SignalMapCreatedWaiter = client.get_waiter("signal_map_created")
  signal_map_monitor_deleted_waiter: SignalMapMonitorDeletedWaiter = client.get_waiter(
      "signal_map_monitor_deleted"
  )
  signal_map_monitor_deployed_waiter: SignalMapMonitorDeployedWaiter = client.get_waiter(
      "signal_map_monitor_deployed"
  )
  signal_map_updated_waiter: SignalMapUpdatedWaiter = client.get_waiter("signal_map_updated")
  ```

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



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

  Full list of `MediaLive` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_medialive/literals/).

  ```python
  from mypy_boto3_medialive.literals import AacCodingModeType


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

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



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

  Full list of `MediaLive` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_medialive/type_defs/).

  ```python
  from mypy_boto3_medialive.type_defs import AacSettingsTypeDef


  def get_value() -> AacSettingsTypeDef:
      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>



  `mypy-boto3-medialive` 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/boto3_stubs_docs/mypy_boto3_medialive/)

  <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: e09c8a9d950fd56f36091c2bb2f34e1acaa13fefa259332fd2a8f030f9c45b9e
name: python-mypy-boto3-medialive-help
arch: noarch
version: 1.35.85
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-medialive
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-medialive-1.35.85-1.src.rpm
location_href: Packages/python-mypy-boto3-medialive-help-1.35.85-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-medialive"></a>



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

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

  Type annotations for [boto3 MediaLive 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-medialive docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_medialive/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-medialive](#mypy-boto3-medialive)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `MediaLive` 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 `MediaLive`.

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



  Install `boto3-stubs` for `MediaLive` service.

  ```bash

  python -m pip install 'boto3-stubs[medialive]'



  python -m pip install 'boto3-stubs-lite[medialive]'


  python -m pip install mypy-boto3-medialive
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-medialive
  ```

  <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 `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[medialive]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  - 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 `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  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 `boto3-stubs[medialive]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[medialive]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-medialive` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `MediaLiveClient` provides annotations for `boto3.client("medialive")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_medialive import MediaLiveClient

  client: MediaLiveClient = Session().client("medialive")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_medialive import MediaLiveClient
  from mypy_boto3_medialive.paginator import (
      DescribeSchedulePaginator,
      ListChannelPlacementGroupsPaginator,
      ListChannelsPaginator,
      ListCloudWatchAlarmTemplateGroupsPaginator,
      ListCloudWatchAlarmTemplatesPaginator,
      ListClustersPaginator,
      ListEventBridgeRuleTemplateGroupsPaginator,
      ListEventBridgeRuleTemplatesPaginator,
      ListInputDeviceTransfersPaginator,
      ListInputDevicesPaginator,
      ListInputSecurityGroupsPaginator,
      ListInputsPaginator,
      ListMultiplexProgramsPaginator,
      ListMultiplexesPaginator,
      ListNetworksPaginator,
      ListNodesPaginator,
      ListOfferingsPaginator,
      ListReservationsPaginator,
      ListSignalMapsPaginator,
  )

  client: MediaLiveClient = Session().client("medialive")



  describe_schedule_paginator: DescribeSchedulePaginator = client.get_paginator("describe_schedule")
  list_channel_placement_groups_paginator: ListChannelPlacementGroupsPaginator = client.get_paginator(
      "list_channel_placement_groups"
  )
  list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels")
  list_cloud_watch_alarm_template_groups_paginator: ListCloudWatchAlarmTemplateGroupsPaginator = (
      client.get_paginator("list_cloud_watch_alarm_template_groups")
  )
  list_cloud_watch_alarm_templates_paginator: ListCloudWatchAlarmTemplatesPaginator = (
      client.get_paginator("list_cloud_watch_alarm_templates")
  )
  list_clusters_paginator: ListClustersPaginator = client.get_paginator("list_clusters")
  list_event_bridge_rule_template_groups_paginator: ListEventBridgeRuleTemplateGroupsPaginator = (
      client.get_paginator("list_event_bridge_rule_template_groups")
  )
  list_event_bridge_rule_templates_paginator: ListEventBridgeRuleTemplatesPaginator = (
      client.get_paginator("list_event_bridge_rule_templates")
  )
  list_input_device_transfers_paginator: ListInputDeviceTransfersPaginator = client.get_paginator(
      "list_input_device_transfers"
  )
  list_input_devices_paginator: ListInputDevicesPaginator = client.get_paginator("list_input_devices")
  list_input_security_groups_paginator: ListInputSecurityGroupsPaginator = client.get_paginator(
      "list_input_security_groups"
  )
  list_inputs_paginator: ListInputsPaginator = client.get_paginator("list_inputs")
  list_multiplex_programs_paginator: ListMultiplexProgramsPaginator = client.get_paginator(
      "list_multiplex_programs"
  )
  list_multiplexes_paginator: ListMultiplexesPaginator = client.get_paginator("list_multiplexes")
  list_networks_paginator: ListNetworksPaginator = client.get_paginator("list_networks")
  list_nodes_paginator: ListNodesPaginator = client.get_paginator("list_nodes")
  list_offerings_paginator: ListOfferingsPaginator = client.get_paginator("list_offerings")
  list_reservations_paginator: ListReservationsPaginator = client.get_paginator("list_reservations")
  list_signal_maps_paginator: ListSignalMapsPaginator = client.get_paginator("list_signal_maps")
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_medialive import MediaLiveClient
  from mypy_boto3_medialive.waiter import (
      ChannelCreatedWaiter,
      ChannelDeletedWaiter,
      ChannelPlacementGroupAssignedWaiter,
      ChannelPlacementGroupDeletedWaiter,
      ChannelPlacementGroupUnassignedWaiter,
      ChannelRunningWaiter,
      ChannelStoppedWaiter,
      ClusterCreatedWaiter,
      ClusterDeletedWaiter,
      InputAttachedWaiter,
      InputDeletedWaiter,
      InputDetachedWaiter,
      MultiplexCreatedWaiter,
      MultiplexDeletedWaiter,
      MultiplexRunningWaiter,
      MultiplexStoppedWaiter,
      NodeDeregisteredWaiter,
      NodeRegisteredWaiter,
      SignalMapCreatedWaiter,
      SignalMapMonitorDeletedWaiter,
      SignalMapMonitorDeployedWaiter,
      SignalMapUpdatedWaiter,
  )

  client: MediaLiveClient = Session().client("medialive")



  channel_created_waiter: ChannelCreatedWaiter = client.get_waiter("channel_created")
  channel_deleted_waiter: ChannelDeletedWaiter = client.get_waiter("channel_deleted")
  channel_placement_group_assigned_waiter: ChannelPlacementGroupAssignedWaiter = client.get_waiter(
      "channel_placement_group_assigned"
  )
  channel_placement_group_deleted_waiter: ChannelPlacementGroupDeletedWaiter = client.get_waiter(
      "channel_placement_group_deleted"
  )
  channel_placement_group_unassigned_waiter: ChannelPlacementGroupUnassignedWaiter = (
      client.get_waiter("channel_placement_group_unassigned")
  )
  channel_running_waiter: ChannelRunningWaiter = client.get_waiter("channel_running")
  channel_stopped_waiter: ChannelStoppedWaiter = client.get_waiter("channel_stopped")
  cluster_created_waiter: ClusterCreatedWaiter = client.get_waiter("cluster_created")
  cluster_deleted_waiter: ClusterDeletedWaiter = client.get_waiter("cluster_deleted")
  input_attached_waiter: InputAttachedWaiter = client.get_waiter("input_attached")
  input_deleted_waiter: InputDeletedWaiter = client.get_waiter("input_deleted")
  input_detached_waiter: InputDetachedWaiter = client.get_waiter("input_detached")
  multiplex_created_waiter: MultiplexCreatedWaiter = client.get_waiter("multiplex_created")
  multiplex_deleted_waiter: MultiplexDeletedWaiter = client.get_waiter("multiplex_deleted")
  multiplex_running_waiter: MultiplexRunningWaiter = client.get_waiter("multiplex_running")
  multiplex_stopped_waiter: MultiplexStoppedWaiter = client.get_waiter("multiplex_stopped")
  node_deregistered_waiter: NodeDeregisteredWaiter = client.get_waiter("node_deregistered")
  node_registered_waiter: NodeRegisteredWaiter = client.get_waiter("node_registered")
  signal_map_created_waiter: SignalMapCreatedWaiter = client.get_waiter("signal_map_created")
  signal_map_monitor_deleted_waiter: SignalMapMonitorDeletedWaiter = client.get_waiter(
      "signal_map_monitor_deleted"
  )
  signal_map_monitor_deployed_waiter: SignalMapMonitorDeployedWaiter = client.get_waiter(
      "signal_map_monitor_deployed"
  )
  signal_map_updated_waiter: SignalMapUpdatedWaiter = client.get_waiter("signal_map_updated")
  ```

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



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

  Full list of `MediaLive` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_medialive/literals/).

  ```python
  from mypy_boto3_medialive.literals import AacCodingModeType


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

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



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

  Full list of `MediaLive` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_medialive/type_defs/).

  ```python
  from mypy_boto3_medialive.type_defs import AacSettingsTypeDef


  def get_value() -> AacSettingsTypeDef:
      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>



  `mypy-boto3-medialive` 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/boto3_stubs_docs/mypy_boto3_medialive/)

  <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: 775cd5f13bc02fd37e48b94e120751ebf91f2417534fc6899b0bcf02ce9e0149
name: python-mypy-boto3-mwaa-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-mwaa
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-mwaa-1.35.84-1.src.rpm
location_href: Packages/python-mypy-boto3-mwaa-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-mwaa"></a>



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

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

  Type annotations for [boto3 MWAA 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-mwaa docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mwaa/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-mwaa](#mypy-boto3-mwaa)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `MWAA` 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 `MWAA`.

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



  Install `boto3-stubs` for `MWAA` service.

  ```bash

  python -m pip install 'boto3-stubs[mwaa]'



  python -m pip install 'boto3-stubs-lite[mwaa]'


  python -m pip install mypy-boto3-mwaa
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-mwaa
  ```

  <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 `boto3-stubs[mwaa]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mwaa]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[mwaa]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mwaa]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mwaa]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[mwaa]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mwaa]'
  ```

  - 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 `boto3-stubs[mwaa]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mwaa]'
  ```

  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 `boto3-stubs[mwaa]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[mwaa]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-mwaa` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `MWAAClient` provides annotations for `boto3.client("mwaa")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_mwaa import MWAAClient

  client: MWAAClient = Session().client("mwaa")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_mwaa import MWAAClient
  from mypy_boto3_mwaa.paginator import ListEnvironmentsPaginator

  client: MWAAClient = Session().client("mwaa")



  list_environments_paginator: ListEnvironmentsPaginator = client.get_paginator("list_environments")
  ```

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



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

  Full list of `MWAA` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mwaa/literals/).

  ```python
  from mypy_boto3_mwaa.literals import EndpointManagementType


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

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



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

  Full list of `MWAA` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_mwaa/type_defs/).

  ```python
  from mypy_boto3_mwaa.type_defs import CreateCliTokenRequestRequestTypeDef


  def get_value() -> CreateCliTokenRequestRequestTypeDef:
      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>



  `mypy-boto3-mwaa` 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/boto3_stubs_docs/mypy_boto3_mwaa/)

  <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: 24fb5535f4ef23b75a6b6beb2aeb05dd51dd3e630d0438f8f1618c71d72a801f
name: python-mypy-boto3-networkmanager-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-networkmanager
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-networkmanager-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-networkmanager-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-networkmanager"></a>



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

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

  Type annotations for
  [boto3 NetworkManager 1.35.81](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-networkmanager docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-networkmanager](#mypy-boto3-networkmanager)
    - [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.81' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `NetworkManager` 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 `NetworkManager`.

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



  Install `boto3-stubs` for `NetworkManager` service.

  ```bash

  python -m pip install 'boto3-stubs[networkmanager]'



  python -m pip install 'boto3-stubs-lite[networkmanager]'


  python -m pip install mypy-boto3-networkmanager
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-networkmanager
  ```

  <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 `boto3-stubs[networkmanager]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[networkmanager]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[networkmanager]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[networkmanager]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[networkmanager]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[networkmanager]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[networkmanager]'
  ```

  - 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 `boto3-stubs[networkmanager]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[networkmanager]'
  ```

  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 `boto3-stubs[networkmanager]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[networkmanager]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-networkmanager` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `NetworkManagerClient` provides annotations for
  `boto3.client("networkmanager")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_networkmanager import NetworkManagerClient

  client: NetworkManagerClient = Session().client("networkmanager")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_networkmanager import NetworkManagerClient
  from mypy_boto3_networkmanager.paginator import (
      DescribeGlobalNetworksPaginator,
      GetConnectPeerAssociationsPaginator,
      GetConnectionsPaginator,
      GetCoreNetworkChangeEventsPaginator,
      GetCoreNetworkChangeSetPaginator,
      GetCustomerGatewayAssociationsPaginator,
      GetDevicesPaginator,
      GetLinkAssociationsPaginator,
      GetLinksPaginator,
      GetNetworkResourceCountsPaginator,
      GetNetworkResourceRelationshipsPaginator,
      GetNetworkResourcesPaginator,
      GetNetworkTelemetryPaginator,
      GetSitesPaginator,
      GetTransitGatewayConnectPeerAssociationsPaginator,
      GetTransitGatewayRegistrationsPaginator,
      ListAttachmentsPaginator,
      ListConnectPeersPaginator,
      ListCoreNetworkPolicyVersionsPaginator,
      ListCoreNetworksPaginator,
      ListPeeringsPaginator,
  )

  client: NetworkManagerClient = Session().client("networkmanager")



  describe_global_networks_paginator: DescribeGlobalNetworksPaginator = client.get_paginator(
      "describe_global_networks"
  )
  get_connect_peer_associations_paginator: GetConnectPeerAssociationsPaginator = client.get_paginator(
      "get_connect_peer_associations"
  )
  get_connections_paginator: GetConnectionsPaginator = client.get_paginator("get_connections")
  get_core_network_change_events_paginator: GetCoreNetworkChangeEventsPaginator = (
      client.get_paginator("get_core_network_change_events")
  )
  get_core_network_change_set_paginator: GetCoreNetworkChangeSetPaginator = client.get_paginator(
      "get_core_network_change_set"
  )
  get_customer_gateway_associations_paginator: GetCustomerGatewayAssociationsPaginator = (
      client.get_paginator("get_customer_gateway_associations")
  )
  get_devices_paginator: GetDevicesPaginator = client.get_paginator("get_devices")
  get_link_associations_paginator: GetLinkAssociationsPaginator = client.get_paginator(
      "get_link_associations"
  )
  get_links_paginator: GetLinksPaginator = client.get_paginator("get_links")
  get_network_resource_counts_paginator: GetNetworkResourceCountsPaginator = client.get_paginator(
      "get_network_resource_counts"
  )
  get_network_resource_relationships_paginator: GetNetworkResourceRelationshipsPaginator = (
      client.get_paginator("get_network_resource_relationships")
  )
  get_network_resources_paginator: GetNetworkResourcesPaginator = client.get_paginator(
      "get_network_resources"
  )
  get_network_telemetry_paginator: GetNetworkTelemetryPaginator = client.get_paginator(
      "get_network_telemetry"
  )
  get_sites_paginator: GetSitesPaginator = client.get_paginator("get_sites")
  get_transit_gateway_connect_peer_associations_paginator: GetTransitGatewayConnectPeerAssociationsPaginator = client.get_paginator(
      "get_transit_gateway_connect_peer_associations"
  )
  get_transit_gateway_registrations_paginator: GetTransitGatewayRegistrationsPaginator = (
      client.get_paginator("get_transit_gateway_registrations")
  )
  list_attachments_paginator: ListAttachmentsPaginator = client.get_paginator("list_attachments")
  list_connect_peers_paginator: ListConnectPeersPaginator = client.get_paginator("list_connect_peers")
  list_core_network_policy_versions_paginator: ListCoreNetworkPolicyVersionsPaginator = (
      client.get_paginator("list_core_network_policy_versions")
  )
  list_core_networks_paginator: ListCoreNetworksPaginator = client.get_paginator("list_core_networks")
  list_peerings_paginator: ListPeeringsPaginator = client.get_paginator("list_peerings")
  ```

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



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

  Full list of `NetworkManager` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/literals/).

  ```python
  from mypy_boto3_networkmanager.literals import AttachmentErrorCodeType


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

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



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

  Full list of `NetworkManager` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_networkmanager/type_defs/).

  ```python
  from mypy_boto3_networkmanager.type_defs import AWSLocationTypeDef


  def get_value() -> AWSLocationTypeDef:
      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>



  `mypy-boto3-networkmanager` 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/boto3_stubs_docs/mypy_boto3_networkmanager/)

  <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: 9dc001361ea5a7cd9a85d9997721f82e86f0b791b6d90106eb3589e01fcc45dd
name: python-mypy-boto3-qconnect-help
arch: noarch
version: 1.35.85
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-qconnect
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-qconnect-1.35.85-1.src.rpm
location_href: Packages/python-mypy-boto3-qconnect-help-1.35.85-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-qconnect"></a>



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

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

  Type annotations for [boto3 QConnect 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-qconnect docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_qconnect/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-qconnect](#mypy-boto3-qconnect)
    - [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.85' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `QConnect` 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 `QConnect`.

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



  Install `boto3-stubs` for `QConnect` service.

  ```bash

  python -m pip install 'boto3-stubs[qconnect]'



  python -m pip install 'boto3-stubs-lite[qconnect]'


  python -m pip install mypy-boto3-qconnect
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-qconnect
  ```

  <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 `boto3-stubs[qconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[qconnect]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[qconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[qconnect]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[qconnect]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[qconnect]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[qconnect]'
  ```

  - 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 `boto3-stubs[qconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[qconnect]'
  ```

  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 `boto3-stubs[qconnect]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[qconnect]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-qconnect` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `QConnectClient` provides annotations for `boto3.client("qconnect")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_qconnect import QConnectClient

  client: QConnectClient = Session().client("qconnect")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_qconnect import QConnectClient
  from mypy_boto3_qconnect.paginator import (
      ListAIAgentVersionsPaginator,
      ListAIAgentsPaginator,
      ListAIGuardrailVersionsPaginator,
      ListAIGuardrailsPaginator,
      ListAIPromptVersionsPaginator,
      ListAIPromptsPaginator,
      ListAssistantAssociationsPaginator,
      ListAssistantsPaginator,
      ListContentAssociationsPaginator,
      ListContentsPaginator,
      ListImportJobsPaginator,
      ListKnowledgeBasesPaginator,
      ListMessageTemplateVersionsPaginator,
      ListMessageTemplatesPaginator,
      ListMessagesPaginator,
      ListQuickResponsesPaginator,
      QueryAssistantPaginator,
      SearchContentPaginator,
      SearchMessageTemplatesPaginator,
      SearchQuickResponsesPaginator,
      SearchSessionsPaginator,
  )

  client: QConnectClient = Session().client("qconnect")



  list_ai_agent_versions_paginator: ListAIAgentVersionsPaginator = client.get_paginator(
      "list_ai_agent_versions"
  )
  list_ai_agents_paginator: ListAIAgentsPaginator = client.get_paginator("list_ai_agents")
  list_ai_guardrail_versions_paginator: ListAIGuardrailVersionsPaginator = client.get_paginator(
      "list_ai_guardrail_versions"
  )
  list_ai_guardrails_paginator: ListAIGuardrailsPaginator = client.get_paginator("list_ai_guardrails")
  list_ai_prompt_versions_paginator: ListAIPromptVersionsPaginator = client.get_paginator(
      "list_ai_prompt_versions"
  )
  list_ai_prompts_paginator: ListAIPromptsPaginator = client.get_paginator("list_ai_prompts")
  list_assistant_associations_paginator: ListAssistantAssociationsPaginator = client.get_paginator(
      "list_assistant_associations"
  )
  list_assistants_paginator: ListAssistantsPaginator = client.get_paginator("list_assistants")
  list_content_associations_paginator: ListContentAssociationsPaginator = client.get_paginator(
      "list_content_associations"
  )
  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_message_template_versions_paginator: ListMessageTemplateVersionsPaginator = (
      client.get_paginator("list_message_template_versions")
  )
  list_message_templates_paginator: ListMessageTemplatesPaginator = client.get_paginator(
      "list_message_templates"
  )
  list_messages_paginator: ListMessagesPaginator = client.get_paginator("list_messages")
  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_message_templates_paginator: SearchMessageTemplatesPaginator = client.get_paginator(
      "search_message_templates"
  )
  search_quick_responses_paginator: SearchQuickResponsesPaginator = client.get_paginator(
      "search_quick_responses"
  )
  search_sessions_paginator: SearchSessionsPaginator = client.get_paginator("search_sessions")
  ```

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



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

  Full list of `QConnect` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_qconnect/literals/).

  ```python
  from mypy_boto3_qconnect.literals import AIAgentAssociationConfigurationTypeType


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

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



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

  Full list of `QConnect` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_qconnect/type_defs/).

  ```python
  from mypy_boto3_qconnect.type_defs import AIAgentConfigurationDataTypeDef


  def get_value() -> AIAgentConfigurationDataTypeDef:
      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>



  `mypy-boto3-qconnect` 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/boto3_stubs_docs/mypy_boto3_qconnect/)

  <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: 46a4f1c1c002ec280d800d7e345f1095ba65761dc9c5cdd5a1865b16ea2fa626
name: python-mypy-boto3-quicksight-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-quicksight
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-quicksight-1.35.84-1.src.rpm
location_href: Packages/python-mypy-boto3-quicksight-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-quicksight"></a>



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

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

  Type annotations for
  [boto3 QuickSight 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-quicksight docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_quicksight/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-quicksight](#mypy-boto3-quicksight)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `QuickSight` 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 `QuickSight`.

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



  Install `boto3-stubs` for `QuickSight` service.

  ```bash

  python -m pip install 'boto3-stubs[quicksight]'



  python -m pip install 'boto3-stubs-lite[quicksight]'


  python -m pip install mypy-boto3-quicksight
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-quicksight
  ```

  <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 `boto3-stubs[quicksight]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[quicksight]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[quicksight]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[quicksight]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[quicksight]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[quicksight]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[quicksight]'
  ```

  - 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 `boto3-stubs[quicksight]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[quicksight]'
  ```

  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 `boto3-stubs[quicksight]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[quicksight]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-quicksight` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `QuickSightClient` provides annotations for `boto3.client("quicksight")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_quicksight import QuickSightClient

  client: QuickSightClient = Session().client("quicksight")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_quicksight import QuickSightClient
  from mypy_boto3_quicksight.paginator import (
      DescribeFolderPermissionsPaginator,
      DescribeFolderResolvedPermissionsPaginator,
      ListAnalysesPaginator,
      ListAssetBundleExportJobsPaginator,
      ListAssetBundleImportJobsPaginator,
      ListBrandsPaginator,
      ListCustomPermissionsPaginator,
      ListDashboardVersionsPaginator,
      ListDashboardsPaginator,
      ListDataSetsPaginator,
      ListDataSourcesPaginator,
      ListFolderMembersPaginator,
      ListFoldersForResourcePaginator,
      ListFoldersPaginator,
      ListGroupMembershipsPaginator,
      ListGroupsPaginator,
      ListIAMPolicyAssignmentsForUserPaginator,
      ListIAMPolicyAssignmentsPaginator,
      ListIngestionsPaginator,
      ListNamespacesPaginator,
      ListRoleMembershipsPaginator,
      ListTemplateAliasesPaginator,
      ListTemplateVersionsPaginator,
      ListTemplatesPaginator,
      ListThemeVersionsPaginator,
      ListThemesPaginator,
      ListUserGroupsPaginator,
      ListUsersPaginator,
      SearchAnalysesPaginator,
      SearchDashboardsPaginator,
      SearchDataSetsPaginator,
      SearchDataSourcesPaginator,
      SearchFoldersPaginator,
      SearchGroupsPaginator,
      SearchTopicsPaginator,
  )

  client: QuickSightClient = Session().client("quicksight")



  describe_folder_permissions_paginator: DescribeFolderPermissionsPaginator = client.get_paginator(
      "describe_folder_permissions"
  )
  describe_folder_resolved_permissions_paginator: DescribeFolderResolvedPermissionsPaginator = (
      client.get_paginator("describe_folder_resolved_permissions")
  )
  list_analyses_paginator: ListAnalysesPaginator = client.get_paginator("list_analyses")
  list_asset_bundle_export_jobs_paginator: ListAssetBundleExportJobsPaginator = client.get_paginator(
      "list_asset_bundle_export_jobs"
  )
  list_asset_bundle_import_jobs_paginator: ListAssetBundleImportJobsPaginator = client.get_paginator(
      "list_asset_bundle_import_jobs"
  )
  list_brands_paginator: ListBrandsPaginator = client.get_paginator("list_brands")
  list_custom_permissions_paginator: ListCustomPermissionsPaginator = client.get_paginator(
      "list_custom_permissions"
  )
  list_dashboard_versions_paginator: ListDashboardVersionsPaginator = client.get_paginator(
      "list_dashboard_versions"
  )
  list_dashboards_paginator: ListDashboardsPaginator = client.get_paginator("list_dashboards")
  list_data_sets_paginator: ListDataSetsPaginator = client.get_paginator("list_data_sets")
  list_data_sources_paginator: ListDataSourcesPaginator = client.get_paginator("list_data_sources")
  list_folder_members_paginator: ListFolderMembersPaginator = client.get_paginator(
      "list_folder_members"
  )
  list_folders_for_resource_paginator: ListFoldersForResourcePaginator = client.get_paginator(
      "list_folders_for_resource"
  )
  list_folders_paginator: ListFoldersPaginator = client.get_paginator("list_folders")
  list_group_memberships_paginator: ListGroupMembershipsPaginator = client.get_paginator(
      "list_group_memberships"
  )
  list_groups_paginator: ListGroupsPaginator = client.get_paginator("list_groups")
  list_iam_policy_assignments_for_user_paginator: ListIAMPolicyAssignmentsForUserPaginator = (
      client.get_paginator("list_iam_policy_assignments_for_user")
  )
  list_iam_policy_assignments_paginator: ListIAMPolicyAssignmentsPaginator = client.get_paginator(
      "list_iam_policy_assignments"
  )
  list_ingestions_paginator: ListIngestionsPaginator = client.get_paginator("list_ingestions")
  list_namespaces_paginator: ListNamespacesPaginator = client.get_paginator("list_namespaces")
  list_role_memberships_paginator: ListRoleMembershipsPaginator = client.get_paginator(
      "list_role_memberships"
  )
  list_template_aliases_paginator: ListTemplateAliasesPaginator = client.get_paginator(
      "list_template_aliases"
  )
  list_template_versions_paginator: ListTemplateVersionsPaginator = client.get_paginator(
      "list_template_versions"
  )
  list_templates_paginator: ListTemplatesPaginator = client.get_paginator("list_templates")
  list_theme_versions_paginator: ListThemeVersionsPaginator = client.get_paginator(
      "list_theme_versions"
  )
  list_themes_paginator: ListThemesPaginator = client.get_paginator("list_themes")
  list_user_groups_paginator: ListUserGroupsPaginator = client.get_paginator("list_user_groups")
  list_users_paginator: ListUsersPaginator = client.get_paginator("list_users")
  search_analyses_paginator: SearchAnalysesPaginator = client.get_paginator("search_analyses")
  search_dashboards_paginator: SearchDashboardsPaginator = client.get_paginator("search_dashboards")
  search_data_sets_paginator: SearchDataSetsPaginator = client.get_paginator("search_data_sets")
  search_data_sources_paginator: SearchDataSourcesPaginator = client.get_paginator(
      "search_data_sources"
  )
  search_folders_paginator: SearchFoldersPaginator = client.get_paginator("search_folders")
  search_groups_paginator: SearchGroupsPaginator = client.get_paginator("search_groups")
  search_topics_paginator: SearchTopicsPaginator = client.get_paginator("search_topics")
  ```

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



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

  Full list of `QuickSight` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_quicksight/literals/).

  ```python
  from mypy_boto3_quicksight.literals import AggTypeType


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

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



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

  Full list of `QuickSight` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_quicksight/type_defs/).

  ```python
  from mypy_boto3_quicksight.type_defs import AccountCustomizationTypeDef


  def get_value() -> AccountCustomizationTypeDef:
      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>



  `mypy-boto3-quicksight` 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/boto3_stubs_docs/mypy_boto3_quicksight/)

  <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: d6c0af88b974d6e7d1d90b38cc6d2935e6c3789999d3ed88370cbbae6e63cf1d
name: python-mypy-boto3-rds-help
arch: noarch
version: 1.35.82
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-rds
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-rds-1.35.82-1.src.rpm
location_href: Packages/python-mypy-boto3-rds-help-1.35.82-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-rds"></a>



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

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

  Type annotations for [boto3 RDS 1.35.82](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-rds docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_rds/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-rds](#mypy-boto3-rds)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [VSCode extension](#vscode-extension)
      - [From PyPI with pip](#from-pypi-with-pip)
      - [From conda-forge](#from-conda-forge)
    - [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.82' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `RDS` 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 `RDS`.

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



  Install `boto3-stubs` for `RDS` service.

  ```bash

  python -m pip install 'boto3-stubs[rds]'



  python -m pip install 'boto3-stubs-lite[rds]'


  python -m pip install mypy-boto3-rds
  ```

  <a id="from-conda-forge"></a>



  Add `conda-forge` to your channels with:

  ```bash
  conda config --add channels conda-forge
  conda config --set channel_priority strict
  ```

  Once the `conda-forge` channel has been enabled, `mypy-boto3-rds` can be
  installed with:

  ```bash
  conda install mypy-boto3-rds
  ```

  List all available versions of `mypy-boto3-rds` available on your platform
  with:

  ```bash
  conda search mypy-boto3-rds --channel conda-forge
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-rds
  ```

  <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 `boto3-stubs[rds]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[rds]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[rds]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[rds]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[rds]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[rds]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[rds]'
  ```

  - 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 `boto3-stubs[rds]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[rds]'
  ```

  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 `boto3-stubs[rds]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[rds]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-rds` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `RDSClient` provides annotations for `boto3.client("rds")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_rds import RDSClient

  client: RDSClient = Session().client("rds")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_rds import RDSClient
  from mypy_boto3_rds.paginator import (
      DescribeBlueGreenDeploymentsPaginator,
      DescribeCertificatesPaginator,
      DescribeDBClusterAutomatedBackupsPaginator,
      DescribeDBClusterBacktracksPaginator,
      DescribeDBClusterEndpointsPaginator,
      DescribeDBClusterParameterGroupsPaginator,
      DescribeDBClusterParametersPaginator,
      DescribeDBClusterSnapshotsPaginator,
      DescribeDBClustersPaginator,
      DescribeDBEngineVersionsPaginator,
      DescribeDBInstanceAutomatedBackupsPaginator,
      DescribeDBInstancesPaginator,
      DescribeDBLogFilesPaginator,
      DescribeDBParameterGroupsPaginator,
      DescribeDBParametersPaginator,
      DescribeDBProxiesPaginator,
      DescribeDBProxyEndpointsPaginator,
      DescribeDBProxyTargetGroupsPaginator,
      DescribeDBProxyTargetsPaginator,
      DescribeDBRecommendationsPaginator,
      DescribeDBSecurityGroupsPaginator,
      DescribeDBSnapshotTenantDatabasesPaginator,
      DescribeDBSnapshotsPaginator,
      DescribeDBSubnetGroupsPaginator,
      DescribeEngineDefaultClusterParametersPaginator,
      DescribeEngineDefaultParametersPaginator,
      DescribeEventSubscriptionsPaginator,
      DescribeEventsPaginator,
      DescribeExportTasksPaginator,
      DescribeGlobalClustersPaginator,
      DescribeIntegrationsPaginator,
      DescribeOptionGroupOptionsPaginator,
      DescribeOptionGroupsPaginator,
      DescribeOrderableDBInstanceOptionsPaginator,
      DescribePendingMaintenanceActionsPaginator,
      DescribeReservedDBInstancesOfferingsPaginator,
      DescribeReservedDBInstancesPaginator,
      DescribeSourceRegionsPaginator,
      DescribeTenantDatabasesPaginator,
      DownloadDBLogFilePortionPaginator,
  )

  client: RDSClient = Session().client("rds")



  describe_blue_green_deployments_paginator: DescribeBlueGreenDeploymentsPaginator = (
      client.get_paginator("describe_blue_green_deployments")
  )
  describe_certificates_paginator: DescribeCertificatesPaginator = client.get_paginator(
      "describe_certificates"
  )
  describe_db_cluster_automated_backups_paginator: DescribeDBClusterAutomatedBackupsPaginator = (
      client.get_paginator("describe_db_cluster_automated_backups")
  )
  describe_db_cluster_backtracks_paginator: DescribeDBClusterBacktracksPaginator = (
      client.get_paginator("describe_db_cluster_backtracks")
  )
  describe_db_cluster_endpoints_paginator: DescribeDBClusterEndpointsPaginator = client.get_paginator(
      "describe_db_cluster_endpoints"
  )
  describe_db_cluster_parameter_groups_paginator: DescribeDBClusterParameterGroupsPaginator = (
      client.get_paginator("describe_db_cluster_parameter_groups")
  )
  describe_db_cluster_parameters_paginator: DescribeDBClusterParametersPaginator = (
      client.get_paginator("describe_db_cluster_parameters")
  )
  describe_db_cluster_snapshots_paginator: DescribeDBClusterSnapshotsPaginator = client.get_paginator(
      "describe_db_cluster_snapshots"
  )
  describe_db_clusters_paginator: DescribeDBClustersPaginator = client.get_paginator(
      "describe_db_clusters"
  )
  describe_db_engine_versions_paginator: DescribeDBEngineVersionsPaginator = client.get_paginator(
      "describe_db_engine_versions"
  )
  describe_db_instance_automated_backups_paginator: DescribeDBInstanceAutomatedBackupsPaginator = (
      client.get_paginator("describe_db_instance_automated_backups")
  )
  describe_db_instances_paginator: DescribeDBInstancesPaginator = client.get_paginator(
      "describe_db_instances"
  )
  describe_db_log_files_paginator: DescribeDBLogFilesPaginator = client.get_paginator(
      "describe_db_log_files"
  )
  describe_db_parameter_groups_paginator: DescribeDBParameterGroupsPaginator = client.get_paginator(
      "describe_db_parameter_groups"
  )
  describe_db_parameters_paginator: DescribeDBParametersPaginator = client.get_paginator(
      "describe_db_parameters"
  )
  describe_db_proxies_paginator: DescribeDBProxiesPaginator = client.get_paginator(
      "describe_db_proxies"
  )
  describe_db_proxy_endpoints_paginator: DescribeDBProxyEndpointsPaginator = client.get_paginator(
      "describe_db_proxy_endpoints"
  )
  describe_db_proxy_target_groups_paginator: DescribeDBProxyTargetGroupsPaginator = (
      client.get_paginator("describe_db_proxy_target_groups")
  )
  describe_db_proxy_targets_paginator: DescribeDBProxyTargetsPaginator = client.get_paginator(
      "describe_db_proxy_targets"
  )
  describe_db_recommendations_paginator: DescribeDBRecommendationsPaginator = client.get_paginator(
      "describe_db_recommendations"
  )
  describe_db_security_groups_paginator: DescribeDBSecurityGroupsPaginator = client.get_paginator(
      "describe_db_security_groups"
  )
  describe_db_snapshot_tenant_databases_paginator: DescribeDBSnapshotTenantDatabasesPaginator = (
      client.get_paginator("describe_db_snapshot_tenant_databases")
  )
  describe_db_snapshots_paginator: DescribeDBSnapshotsPaginator = client.get_paginator(
      "describe_db_snapshots"
  )
  describe_db_subnet_groups_paginator: DescribeDBSubnetGroupsPaginator = client.get_paginator(
      "describe_db_subnet_groups"
  )
  describe_engine_default_cluster_parameters_paginator: DescribeEngineDefaultClusterParametersPaginator = client.get_paginator(
      "describe_engine_default_cluster_parameters"
  )
  describe_engine_default_parameters_paginator: DescribeEngineDefaultParametersPaginator = (
      client.get_paginator("describe_engine_default_parameters")
  )
  describe_event_subscriptions_paginator: DescribeEventSubscriptionsPaginator = client.get_paginator(
      "describe_event_subscriptions"
  )
  describe_events_paginator: DescribeEventsPaginator = client.get_paginator("describe_events")
  describe_export_tasks_paginator: DescribeExportTasksPaginator = client.get_paginator(
      "describe_export_tasks"
  )
  describe_global_clusters_paginator: DescribeGlobalClustersPaginator = client.get_paginator(
      "describe_global_clusters"
  )
  describe_integrations_paginator: DescribeIntegrationsPaginator = client.get_paginator(
      "describe_integrations"
  )
  describe_option_group_options_paginator: DescribeOptionGroupOptionsPaginator = client.get_paginator(
      "describe_option_group_options"
  )
  describe_option_groups_paginator: DescribeOptionGroupsPaginator = client.get_paginator(
      "describe_option_groups"
  )
  describe_orderable_db_instance_options_paginator: DescribeOrderableDBInstanceOptionsPaginator = (
      client.get_paginator("describe_orderable_db_instance_options")
  )
  describe_pending_maintenance_actions_paginator: DescribePendingMaintenanceActionsPaginator = (
      client.get_paginator("describe_pending_maintenance_actions")
  )
  describe_reserved_db_instances_offerings_paginator: DescribeReservedDBInstancesOfferingsPaginator = client.get_paginator(
      "describe_reserved_db_instances_offerings"
  )
  describe_reserved_db_instances_paginator: DescribeReservedDBInstancesPaginator = (
      client.get_paginator("describe_reserved_db_instances")
  )
  describe_source_regions_paginator: DescribeSourceRegionsPaginator = client.get_paginator(
      "describe_source_regions"
  )
  describe_tenant_databases_paginator: DescribeTenantDatabasesPaginator = client.get_paginator(
      "describe_tenant_databases"
  )
  download_db_log_file_portion_paginator: DownloadDBLogFilePortionPaginator = client.get_paginator(
      "download_db_log_file_portion"
  )
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_rds import RDSClient
  from mypy_boto3_rds.waiter import (
      DBClusterAvailableWaiter,
      DBClusterDeletedWaiter,
      DBClusterSnapshotAvailableWaiter,
      DBClusterSnapshotDeletedWaiter,
      DBInstanceAvailableWaiter,
      DBInstanceDeletedWaiter,
      DBSnapshotAvailableWaiter,
      DBSnapshotCompletedWaiter,
      DBSnapshotDeletedWaiter,
      TenantDatabaseAvailableWaiter,
      TenantDatabaseDeletedWaiter,
  )

  client: RDSClient = Session().client("rds")



  db_cluster_available_waiter: DBClusterAvailableWaiter = client.get_waiter("db_cluster_available")
  db_cluster_deleted_waiter: DBClusterDeletedWaiter = client.get_waiter("db_cluster_deleted")
  db_cluster_snapshot_available_waiter: DBClusterSnapshotAvailableWaiter = client.get_waiter(
      "db_cluster_snapshot_available"
  )
  db_cluster_snapshot_deleted_waiter: DBClusterSnapshotDeletedWaiter = client.get_waiter(
      "db_cluster_snapshot_deleted"
  )
  db_instance_available_waiter: DBInstanceAvailableWaiter = client.get_waiter("db_instance_available")
  db_instance_deleted_waiter: DBInstanceDeletedWaiter = client.get_waiter("db_instance_deleted")
  db_snapshot_available_waiter: DBSnapshotAvailableWaiter = client.get_waiter("db_snapshot_available")
  db_snapshot_completed_waiter: DBSnapshotCompletedWaiter = client.get_waiter("db_snapshot_completed")
  db_snapshot_deleted_waiter: DBSnapshotDeletedWaiter = client.get_waiter("db_snapshot_deleted")
  tenant_database_available_waiter: TenantDatabaseAvailableWaiter = client.get_waiter(
      "tenant_database_available"
  )
  tenant_database_deleted_waiter: TenantDatabaseDeletedWaiter = client.get_waiter(
      "tenant_database_deleted"
  )
  ```

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



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

  Full list of `RDS` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_rds/literals/).

  ```python
  from mypy_boto3_rds.literals import ActivityStreamModeType


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

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



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

  Full list of `RDS` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_rds/type_defs/).

  ```python
  from mypy_boto3_rds.type_defs import AccountQuotaTypeDef


  def get_value() -> AccountQuotaTypeDef:
      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>



  `mypy-boto3-rds` 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/boto3_stubs_docs/mypy_boto3_rds/)

  <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: f150df6d00b982ea38ef9abb326f2dd27eae22dd1d39dbcd5f86e52b40e9ce77
name: python-mypy-boto3-resiliencehub-help
arch: noarch
version: 1.35.84
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-resiliencehub
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-resiliencehub-1.35.84-1.src.rpm
location_href: Packages/python-mypy-boto3-resiliencehub-help-1.35.84-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-resiliencehub"></a>



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

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

  Type annotations for
  [boto3 ResilienceHub 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-resiliencehub docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_resiliencehub/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-resiliencehub](#mypy-boto3-resiliencehub)
    - [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 (legacy boto3-stubs)` AWS SDK.
  3. Add `ResilienceHub` 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 `ResilienceHub`.

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



  Install `boto3-stubs` for `ResilienceHub` service.

  ```bash

  python -m pip install 'boto3-stubs[resiliencehub]'



  python -m pip install 'boto3-stubs-lite[resiliencehub]'


  python -m pip install mypy-boto3-resiliencehub
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-resiliencehub
  ```

  <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 `boto3-stubs[resiliencehub]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[resiliencehub]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[resiliencehub]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[resiliencehub]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[resiliencehub]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[resiliencehub]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[resiliencehub]'
  ```

  - 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 `boto3-stubs[resiliencehub]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[resiliencehub]'
  ```

  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 `boto3-stubs[resiliencehub]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[resiliencehub]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-resiliencehub` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `ResilienceHubClient` provides annotations for `boto3.client("resiliencehub")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_resiliencehub import ResilienceHubClient

  client: ResilienceHubClient = Session().client("resiliencehub")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_resiliencehub import ResilienceHubClient
  from mypy_boto3_resiliencehub.paginator import (
      ListAppAssessmentResourceDriftsPaginator,
      ListMetricsPaginator,
      ListResourceGroupingRecommendationsPaginator,
  )

  client: ResilienceHubClient = Session().client("resiliencehub")



  list_app_assessment_resource_drifts_paginator: ListAppAssessmentResourceDriftsPaginator = (
      client.get_paginator("list_app_assessment_resource_drifts")
  )
  list_metrics_paginator: ListMetricsPaginator = client.get_paginator("list_metrics")
  list_resource_grouping_recommendations_paginator: ListResourceGroupingRecommendationsPaginator = (
      client.get_paginator("list_resource_grouping_recommendations")
  )
  ```

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



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

  Full list of `ResilienceHub` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_resiliencehub/literals/).

  ```python
  from mypy_boto3_resiliencehub.literals import AlarmTypeType


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

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



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

  Full list of `ResilienceHub` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_resiliencehub/type_defs/).

  ```python
  from mypy_boto3_resiliencehub.type_defs import AcceptGroupingRecommendationEntryTypeDef


  def get_value() -> AcceptGroupingRecommendationEntryTypeDef:
      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>



  `mypy-boto3-resiliencehub` 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/boto3_stubs_docs/mypy_boto3_resiliencehub/)

  <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: bc9497c7a1dc64c5f2e46ea77e81a7d94edacf63014b685adaf980582aa1499f
name: python-mypy-boto3-s3-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-s3
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-s3-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-s3-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-s3"></a>



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

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

  Type annotations for [boto3 S3 1.35.81](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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-s3 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-s3](#mypy-boto3-s3)
    - [How to install](#how-to-install)
      - [Generate locally (recommended)](<#generate-locally-(recommended)>)
      - [VSCode extension](#vscode-extension)
      - [From PyPI with pip](#from-pypi-with-pip)
      - [From conda-forge](#from-conda-forge)
    - [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)
      - [Service Resource annotations](#service-resource-annotations)
      - [Other resources annotations](#other-resources-annotations)
      - [Collections annotations](#collections-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.81' mypy_boto3_builder`
  2. Select `boto3-stubs` AWS SDK.
  3. Add `S3` 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 `S3`.

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



  Install `boto3-stubs` for `S3` service.

  ```bash

  python -m pip install 'boto3-stubs[s3]'



  python -m pip install 'boto3-stubs-lite[s3]'


  python -m pip install mypy-boto3-s3
  ```

  <a id="from-conda-forge"></a>



  Add `conda-forge` to your channels with:

  ```bash
  conda config --add channels conda-forge
  conda config --set channel_priority strict
  ```

  Once the `conda-forge` channel has been enabled, `mypy-boto3-s3` can be
  installed with:

  ```bash
  conda install mypy-boto3-s3
  ```

  List all available versions of `mypy-boto3-s3` available on your platform with:

  ```bash
  conda search mypy-boto3-s3 --channel conda-forge
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-s3
  ```

  <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 `boto3-stubs[s3]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[s3]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[s3]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[s3]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[s3]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[s3]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[s3]'
  ```

  - 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 `boto3-stubs[s3]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[s3]'
  ```

  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 `boto3-stubs[s3]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[s3]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-s3` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `S3Client` provides annotations for `boto3.client("s3")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_s3 import S3Client

  client: S3Client = Session().client("s3")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_s3 import S3Client
  from mypy_boto3_s3.paginator import (
      ListBucketsPaginator,
      ListDirectoryBucketsPaginator,
      ListMultipartUploadsPaginator,
      ListObjectVersionsPaginator,
      ListObjectsPaginator,
      ListObjectsV2Paginator,
      ListPartsPaginator,
  )

  client: S3Client = Session().client("s3")



  list_buckets_paginator: ListBucketsPaginator = client.get_paginator("list_buckets")
  list_directory_buckets_paginator: ListDirectoryBucketsPaginator = client.get_paginator(
      "list_directory_buckets"
  )
  list_multipart_uploads_paginator: ListMultipartUploadsPaginator = client.get_paginator(
      "list_multipart_uploads"
  )
  list_object_versions_paginator: ListObjectVersionsPaginator = client.get_paginator(
      "list_object_versions"
  )
  list_objects_paginator: ListObjectsPaginator = client.get_paginator("list_objects")
  list_objects_v2_paginator: ListObjectsV2Paginator = client.get_paginator("list_objects_v2")
  list_parts_paginator: ListPartsPaginator = client.get_paginator("list_parts")
  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_s3 import S3Client
  from mypy_boto3_s3.waiter import (
      BucketExistsWaiter,
      BucketNotExistsWaiter,
      ObjectExistsWaiter,
      ObjectNotExistsWaiter,
  )

  client: S3Client = Session().client("s3")



  bucket_exists_waiter: BucketExistsWaiter = client.get_waiter("bucket_exists")
  bucket_not_exists_waiter: BucketNotExistsWaiter = client.get_waiter("bucket_not_exists")
  object_exists_waiter: ObjectExistsWaiter = client.get_waiter("object_exists")
  object_not_exists_waiter: ObjectNotExistsWaiter = client.get_waiter("object_not_exists")
  ```

  <a id="service-resource-annotations"></a>



  `S3ServiceResource` provides annotations for `boto3.resource("s3")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_s3 import S3ServiceResource

  resource: S3ServiceResource = Session().resource("s3")


  ```

  <a id="other-resources-annotations"></a>



  `mypy_boto3_s3.service_resource` module contains type annotations for all
  resources.

  ```python
  from boto3.session import Session

  from mypy_boto3_s3 import S3ServiceResource
  from mypy_boto3_s3.service_resource import (
      Bucket,
      BucketAcl,
      BucketCors,
      BucketLifecycle,
      BucketLifecycleConfiguration,
      BucketLogging,
      BucketNotification,
      BucketPolicy,
      BucketRequestPayment,
      BucketTagging,
      BucketVersioning,
      BucketWebsite,
      MultipartUpload,
      MultipartUploadPart,
      Object,
      ObjectAcl,
      ObjectSummary,
      ObjectVersion,
  )

  resource: S3ServiceResource = Session().resource("s3")



  my_bucket: Bucket = resource.Bucket(...)
  my_bucket_acl: BucketAcl = resource.BucketAcl(...)
  my_bucket_cors: BucketCors = resource.BucketCors(...)
  my_bucket_lifecycle: BucketLifecycle = resource.BucketLifecycle(...)
  my_bucket_lifecycle_configuration: BucketLifecycleConfiguration = (
      resource.BucketLifecycleConfiguration(...)
  )
  my_bucket_logging: BucketLogging = resource.BucketLogging(...)
  my_bucket_notification: BucketNotification = resource.BucketNotification(...)
  my_bucket_policy: BucketPolicy = resource.BucketPolicy(...)
  my_bucket_request_payment: BucketRequestPayment = resource.BucketRequestPayment(...)
  my_bucket_tagging: BucketTagging = resource.BucketTagging(...)
  my_bucket_versioning: BucketVersioning = resource.BucketVersioning(...)
  my_bucket_website: BucketWebsite = resource.BucketWebsite(...)
  my_multipart_upload: MultipartUpload = resource.MultipartUpload(...)
  my_multipart_upload_part: MultipartUploadPart = resource.MultipartUploadPart(...)
  my_object: Object = resource.Object(...)
  my_object_acl: ObjectAcl = resource.ObjectAcl(...)
  my_object_summary: ObjectSummary = resource.ObjectSummary(...)
  my_object_version: ObjectVersion = resource.ObjectVersion(...)
  ```

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



  `mypy_boto3_s3.service_resource` module contains type annotations for all
  `S3ServiceResource` collections.

  ```python
  from boto3.session import Session

  from mypy_boto3_s3 import S3ServiceResource
  from mypy_boto3_s3.service_resource import ServiceResourceBucketsCollection

  resource: S3ServiceResource = Session().resource("s3")



  buckets: s3_resources.ServiceResourceBucketsCollection = resource.buckets
  ```

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



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

  Full list of `S3` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3/literals/).

  ```python
  from mypy_boto3_s3.literals import AnalyticsS3ExportFileFormatType


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

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



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

  Full list of `S3` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_s3/type_defs/).

  ```python
  from mypy_boto3_s3.type_defs import AbortIncompleteMultipartUploadTypeDef


  def get_value() -> AbortIncompleteMultipartUploadTypeDef:
      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>



  `mypy-boto3-s3` 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/boto3_stubs_docs/mypy_boto3_s3/)

  <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: 2aef9128d515b5e8d6981cdb7a1475efc05d91298884265ad79fac83ad6bf798
name: python-mypy-boto3-servicediscovery-help
arch: noarch
version: 1.35.81
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-servicediscovery
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-servicediscovery-1.35.81-1.src.rpm
location_href: Packages/python-mypy-boto3-servicediscovery-help-1.35.81-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-servicediscovery"></a>



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

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

  Type annotations for
  [boto3 ServiceDiscovery 1.35.81](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.3](https://github.com/youtype/mypy_boto3_builder).

  More information can be found on
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-servicediscovery docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_servicediscovery/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-servicediscovery](#mypy-boto3-servicediscovery)
    - [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.81' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `ServiceDiscovery` 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 `ServiceDiscovery`.

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



  Install `boto3-stubs` for `ServiceDiscovery` service.

  ```bash

  python -m pip install 'boto3-stubs[servicediscovery]'



  python -m pip install 'boto3-stubs-lite[servicediscovery]'


  python -m pip install mypy-boto3-servicediscovery
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-servicediscovery
  ```

  <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 `boto3-stubs[servicediscovery]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[servicediscovery]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[servicediscovery]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[servicediscovery]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[servicediscovery]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[servicediscovery]` with services you use in your
    environment:

  ```bash
  python -m pip install 'boto3-stubs[servicediscovery]'
  ```

  - 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 `boto3-stubs[servicediscovery]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[servicediscovery]'
  ```

  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 `boto3-stubs[servicediscovery]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[servicediscovery]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-servicediscovery` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `ServiceDiscoveryClient` provides annotations for
  `boto3.client("servicediscovery")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_servicediscovery import ServiceDiscoveryClient

  client: ServiceDiscoveryClient = Session().client("servicediscovery")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_servicediscovery import ServiceDiscoveryClient
  from mypy_boto3_servicediscovery.paginator import (
      ListInstancesPaginator,
      ListNamespacesPaginator,
      ListOperationsPaginator,
      ListServicesPaginator,
  )

  client: ServiceDiscoveryClient = Session().client("servicediscovery")



  list_instances_paginator: ListInstancesPaginator = client.get_paginator("list_instances")
  list_namespaces_paginator: ListNamespacesPaginator = client.get_paginator("list_namespaces")
  list_operations_paginator: ListOperationsPaginator = client.get_paginator("list_operations")
  list_services_paginator: ListServicesPaginator = client.get_paginator("list_services")
  ```

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



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

  Full list of `ServiceDiscovery` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_servicediscovery/literals/).

  ```python
  from mypy_boto3_servicediscovery.literals import CustomHealthStatusType


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

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



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

  Full list of `ServiceDiscovery` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_servicediscovery/type_defs/).

  ```python
  from mypy_boto3_servicediscovery.type_defs import TagTypeDef


  def get_value() -> TagTypeDef:
      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>



  `mypy-boto3-servicediscovery` 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/boto3_stubs_docs/mypy_boto3_servicediscovery/)

  <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: 31256298e8b214477c684425d7fd3c5c637c880b835f29e860ff12031b513dab
name: python-mypy-boto3-ssm-sap-help
arch: noarch
version: 1.35.85
epoch: 0
release: 1
summary: Development documents and examples for mypy-boto3-ssm-sap
url: https://github.com/youtype/mypy_boto3_builder
rpm_license: MIT License
rpm_group: Unspecified
rpm_buildhost: localhost
rpm_sourcerpm: python-mypy-boto3-ssm-sap-1.35.85-1.src.rpm
location_href: Packages/python-mypy-boto3-ssm-sap-help-1.35.85-1.noarch.rpm
checksum_type: sha256
description:
  <a id="mypy-boto3-ssm-sap"></a>



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

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

  Type annotations for [boto3 SsmSap 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
  [boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in
  [mypy-boto3-ssm-sap docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ssm_sap/).

  See how it helps you find and fix potential bugs:

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

  - [mypy-boto3-ssm-sap](#mypy-boto3-ssm-sap)
    - [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.85' mypy_boto3_builder`
  2. Select `boto3 (legacy boto3-stubs)` AWS SDK.
  3. Add `SsmSap` 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 `SsmSap`.

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



  Install `boto3-stubs` for `SsmSap` service.

  ```bash

  python -m pip install 'boto3-stubs[ssm-sap]'



  python -m pip install 'boto3-stubs-lite[ssm-sap]'


  python -m pip install mypy-boto3-ssm-sap
  ```

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



  ```bash
  python -m pip uninstall -y mypy-boto3-ssm-sap
  ```

  <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 `boto3-stubs[ssm-sap]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ssm-sap]'
  ```

  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 [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-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
  > `boto3-stubs` with
  > [boto3-stubs-lite](https://pypi.org/project/boto3-stubs-lite/):

  ```bash
  pip uninstall boto3-stubs
  pip install boto3-stubs-lite
  ```

  Install `boto3-stubs[ssm-sap]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ssm-sap]'
  ```

  Both type checking and code completion should now work.

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



  - Install `boto3-stubs` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ssm-sap]'
  ```

  - Install [use-package](https://github.com/jwiegley/use-package),
    [lsp](https://github.com/emacs-lsp/lsp-mode/),
    [company](https://github.com/company-mode/company-mode) and
    [flycheck](https://github.com/flycheck/flycheck) packages
  - Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package

  ```elisp
  (use-package lsp-pyright
    :ensure t
    :hook (python-mode . (lambda ()
                            (require 'lsp-pyright)
                            (lsp)))  ; or lsp-deferred
    :init (when (executable-find "python3")
            (setq lsp-pyright-python-executable-cmd "python3"))
    )
  ```

  - Make sure emacs uses the environment where you have installed `boto3-stubs`

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

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



  - Install `boto3-stubs[ssm-sap]` with services you use in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ssm-sap]'
  ```

  - 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 `boto3-stubs[ssm-sap]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ssm-sap]'
  ```

  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 `boto3-stubs[ssm-sap]` in your environment:

  ```bash
  python -m pip install 'boto3-stubs[ssm-sap]'
  ```

  Optionally, you can install `boto3-stubs` 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
  `mypy-boto3-ssm-sap` 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 mypy_boto3_ec2 import EC2Client, EC2ServiceResource
      from mypy_boto3_ec2.waiters import BundleTaskCompleteWaiter
      from mypy_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>



  `SsmSapClient` provides annotations for `boto3.client("ssm-sap")`.

  ```python
  from boto3.session import Session

  from mypy_boto3_ssm_sap import SsmSapClient

  client: SsmSapClient = Session().client("ssm-sap")


  ```

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



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

  ```python
  from boto3.session import Session

  from mypy_boto3_ssm_sap import SsmSapClient
  from mypy_boto3_ssm_sap.paginator import (
      ListApplicationsPaginator,
      ListComponentsPaginator,
      ListDatabasesPaginator,
      ListOperationEventsPaginator,
      ListOperationsPaginator,
  )

  client: SsmSapClient = Session().client("ssm-sap")



  list_applications_paginator: ListApplicationsPaginator = client.get_paginator("list_applications")
  list_components_paginator: ListComponentsPaginator = client.get_paginator("list_components")
  list_databases_paginator: ListDatabasesPaginator = client.get_paginator("list_databases")
  list_operation_events_paginator: ListOperationEventsPaginator = client.get_paginator(
      "list_operation_events"
  )
  list_operations_paginator: ListOperationsPaginator = client.get_paginator("list_operations")
  ```

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



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

  Full list of `SsmSap` Literals can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ssm_sap/literals/).

  ```python
  from mypy_boto3_ssm_sap.literals import AllocationTypeType


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

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



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

  Full list of `SsmSap` TypeDefs can be found in
  [docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ssm_sap/type_defs/).

  ```python
  from mypy_boto3_ssm_sap.type_defs import ApplicationCredentialTypeDef


  def get_value() -> ApplicationCredentialTypeDef:
      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>



  `mypy-boto3-ssm-sap` 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/boto3_stubs_docs/mypy_boto3_ssm_sap/)

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


