mypy-boto3-opensearch

Type annotations for boto3 OpenSearchService 1.40.0 compatible with VSCode, PyCharm, Emacs, Sublime Text, mypy, pyright and other tools.

Generated with mypy-boto3-builder 8.11.0.

More information can be found on boto3-stubs page and in mypy-boto3-opensearch docs.

See how it helps you find and fix potential bugs:

• mypy-boto3-opensearch
  • How to install
    • Generate locally (recommended)
    • VSCode extension
    • From PyPI with pip
  • How to uninstall
  • Usage
    • VSCode
    • PyCharm
    • Emacs
    • Sublime Text
    • Other IDEs
    • mypy
    • pyright
    • Pylint compatibility
  • Explicit type annotations
    • Client annotations
    • Paginators annotations
    • Literals
    • Type definitions
  • How it works
  • What's new
    • Implemented features
    • Latest changes
  • Versioning
  • Thank you
  • Documentation
  • Support and contributing

How to install

Generate locally (recommended)

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

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

VSCode extension

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and OpenSearchService.

From PyPI with pip

Install boto3-stubs for OpenSearchService service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[opensearch]'

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

# standalone installation
python -m pip install mypy-boto3-opensearch

How to uninstall

python -m pip uninstall -y mypy-boto3-opensearch

Usage

VSCode

• Install Python extension
• Install Pylance extension
• Set Pylance as your Python Language Server
• Install boto3-stubs[opensearch] in your environment:

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

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

PyCharm

⚠️ Due to slow PyCharm performance on Literal overloads (issue PY-40997), it is recommended to use 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 or pyright instead.

⚠️ To continue using PyCharm type checker, you can try to replace boto3-stubs with boto3-stubs-lite:

pip uninstall boto3-stubs
pip install boto3-stubs-lite

Install boto3-stubs[opensearch] in your environment:

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

Both type checking and code completion should now work.

Emacs

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

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

• Install use-package, lsp, company and flycheck packages
• Install lsp-pyright package

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

Sublime Text

• Install boto3-stubs[opensearch] with services you use in your environment:

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

• Install LSP-pyright package

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

Other IDEs

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

mypy

• Install mypy: python -m pip install mypy
• Install boto3-stubs[opensearch] in your environment:

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

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

pyright

• Install pyright: npm i -g pyright
• Install boto3-stubs[opensearch] in your environment:

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

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.

Pylint compatibility

It is totally safe to use TYPE_CHECKING flag in order to avoid mypy-boto3-opensearch 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.

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

...

Explicit type annotations

Client annotations

OpenSearchServiceClient provides annotations for boto3.client("opensearch").

from boto3.session import Session

from mypy_boto3_opensearch import OpenSearchServiceClient

client: OpenSearchServiceClient = Session().client("opensearch")

# now client usage is checked by mypy and IDE should provide code completion

Paginators annotations

mypy_boto3_opensearch.paginator module contains type annotations for all paginators.

from boto3.session import Session

from mypy_boto3_opensearch import OpenSearchServiceClient
from mypy_boto3_opensearch.paginator import ListApplicationsPaginator

client: OpenSearchServiceClient = Session().client("opensearch")

# Explicit type annotations are optional here
# Types should be correctly discovered by mypy and IDEs
list_applications_paginator: ListApplicationsPaginator = client.get_paginator("list_applications")

Literals

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

Full list of OpenSearchService Literals can be found in docs.

from mypy_boto3_opensearch.literals import AWSServicePrincipalType


def check_value(value: AWSServicePrincipalType) -> bool: ...

Type definitions

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

Full list of OpenSearchService TypeDefs can be found in docs.

# TypedDict usage example
from mypy_boto3_opensearch.type_defs import NaturalLanguageQueryGenerationOptionsInputTypeDef


def get_value() -> NaturalLanguageQueryGenerationOptionsInputTypeDef:
    return {
        "DesiredState": ...,
    }

How it works

Fully automated 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 for readability.

What's new

Implemented features

• Fully type annotated boto3, botocore, aiobotocore and aioboto3 libraries
• mypy, pyright, VSCode, PyCharm, Sublime Text and Emacs compatibility
• Client, ServiceResource, Resource, Waiter Paginator type annotations for each service
• Generated TypeDefs for each service
• Generated Literals for each service
• Auto discovery of types for boto3.client and boto3.resource calls
• Auto discovery of types for session.client and session.resource calls
• Auto discovery of types for client.get_waiter and client.get_paginator calls
• Auto discovery of types for ServiceResource and Resource collections
• Auto discovery of types for aiobotocore.Session.create_client calls

Latest changes

Builder changelog can be found in Releases.

Versioning

mypy-boto3-opensearch version is the same as related boto3 version and follows Python Packaging version specifiers.

Thank you

• Allie Fitter for boto3-type-annotations, this package is based on top of his work
• black developers for an awesome formatting tool
• Timothy Edmund Crosley for isort and how flexible it is
• mypy developers for doing all dirty work for us
• pyright team for the new era of typed Python

Documentation

All services type annotations can be found in boto3 docs

Support and contributing

This package is auto-generated. Please reports any bugs or request new features in mypy-boto3-builder repository.