Skip to content

OpenSearchService module

Index > OpenSearchService

Auto-generated documentation for OpenSearchService type annotations stubs module mypy-boto3-opensearch.

How to install

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

Code samples can be found in Examples.

OpenSearchServiceClient

Type annotations and code completion for boto3.client("opensearch") as OpenSearchServiceClient boto3 documentation

Usage example
from boto3.session import Session

from mypy_boto3_opensearch.client import OpenSearchServiceClient

def get_client() -> OpenSearchServiceClient:
    return Session().client("opensearch")

Literals

Type annotations for literals used in methods and schemas.

Usage example
from mypy_boto3_opensearch.literals import AutoTuneDesiredStateType

def get_value() -> AutoTuneDesiredStateType:
    return "DISABLED"

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_opensearch.type_defs import AWSDomainInformationTypeDef

def get_value() -> AWSDomainInformationTypeDef:
    return {
        "DomainName": ...,
    }