Skip to content

OpenSearchService module#

Index > OpenSearchService

Auto-generated documentation for OpenSearchService type annotations stubs module types-aiobotocore-opensearch.

How to install#

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

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

From PyPI with pip#

Install types-aiobotocore for OpenSearchService service.

# install with aiobotocore type annotations
python -m pip install 'types-aiobotocore[opensearch]'

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

# standalone installation
python -m pip install types-aiobotocore-opensearch

How to uninstall#

python -m pip uninstall -y types-aiobotocore-opensearch

Usage#

Code samples can be found in Examples.

OpenSearchServiceClient#

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

# OpenSearchServiceClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_opensearch.client import OpenSearchServiceClient


session = get_session()
async with session.create_client("opensearch") as client:
    client: OpenSearchServiceClient

Paginators#

Type annotations and code completion for paginators from session.create_client("opensearch").get_paginator("...").

# ListApplicationsPaginator usage example

from types_aiobotocore_opensearch.paginator import ListApplicationsPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# AWSServicePrincipalType usage example

from types_aiobotocore_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.