Skip to content

ElasticsearchService module#

Index > ElasticsearchService

Auto-generated documentation for ElasticsearchService type annotations stubs module types-aiobotocore-es.

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 ElasticsearchService service.
  4. Use provided commands to install generated packages.

From PyPI with pip#

Install types-aiobotocore for ElasticsearchService service.

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

# 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[es]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

ElasticsearchServiceClient#

Type annotations and code completion for session.create_client("es") as ElasticsearchServiceClient boto3 documentation

# ElasticsearchServiceClient usage example

from aiobotocore.session import get_session

from types_aiobotocore_es.client import ElasticsearchServiceClient


session = get_session()
async with session.create_client("es") as client:
    client: ElasticsearchServiceClient

Paginators#

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

# DescribeReservedElasticsearchInstanceOfferingsPaginator usage example

from types_aiobotocore_es.paginator import DescribeReservedElasticsearchInstanceOfferingsPaginator

def get_describe_reserved_elasticsearch_instance_offerings_paginator() -> DescribeReservedElasticsearchInstanceOfferingsPaginator:
    return client.get_paginator("describe_reserved_elasticsearch_instance_offerings"))

Literals#

Type annotations for literals used in methods and schema.

# AutoTuneDesiredStateType usage example

from types_aiobotocore_es.literals import AutoTuneDesiredStateType

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

Type definitions#

Type annotations for type definitions used in methods and schema.