Skip to content

OpenSearchService module#

Index > OpenSearchService

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

How to install#

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.38.18' 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#

Code samples can be found in Examples.

OpenSearchServiceClient#

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

# OpenSearchServiceClient usage example

from boto3.session import Session

from mypy_boto3_opensearch.client import OpenSearchServiceClient

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

Paginators#

Type annotations and code completion for paginators from boto3.client("opensearch").get_paginator("...").

# ListApplicationsPaginator usage example

from boto3.session import Session

from mypy_boto3_opensearch.paginator import ListApplicationsPaginator

def get_list_applications_paginator() -> ListApplicationsPaginator:
    return Session().client("opensearch").get_paginator("list_applications"))

Literals#

Type annotations for literals used in methods and schema.

# AWSServicePrincipalType usage example

from mypy_boto3_opensearch.literals import AWSServicePrincipalType

def get_value() -> AWSServicePrincipalType:
    return "application.opensearchservice.amazonaws.com"

Type definitions#

Type annotations for type definitions used in methods and schema.