Skip to content

ElasticsearchService module#

Index > ElasticsearchService

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

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.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add ElasticsearchService 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 ElasticsearchService.

From PyPI with pip#

Install types-boto3 for ElasticsearchService service.

# install with boto3 type annotations
python -m pip install 'types-boto3[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-boto3-lite[es]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

ElasticsearchServiceClient#

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

# ElasticsearchServiceClient usage example

from boto3.session import Session

from types_boto3_es.client import ElasticsearchServiceClient

def get_client() -> ElasticsearchServiceClient:
    return Session().client("es")

Paginators#

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

# DescribeReservedElasticsearchInstanceOfferingsPaginator usage example

from boto3.session import Session

from types_boto3_es.paginator import DescribeReservedElasticsearchInstanceOfferingsPaginator

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

Literals#

Type annotations for literals used in methods and schema.

# AutoTuneDesiredStateType usage example

from types_boto3_es.literals import AutoTuneDesiredStateType

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

Type definitions#

Type annotations for type definitions used in methods and schema.