Skip to content

ElasticsearchService module#

Index > ElasticsearchService

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

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 ElasticsearchService.

From PyPI with pip#

Install boto3-stubs for ElasticsearchService service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[es]'

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

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

How to uninstall#

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


Code samples can be found in Examples.


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

# ElasticsearchServiceClient usage example

from boto3.session import Session

from mypy_boto3_es.client import ElasticsearchServiceClient

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


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

# DescribeReservedElasticsearchInstanceOfferingsPaginator usage example

from boto3.session import Session

from mypy_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"))


Type annotations for literals used in methods and schemas.

# AutoTuneDesiredStateType usage example

from mypy_boto3_es.literals import AutoTuneDesiredStateType

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

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef usage example

from mypy_boto3_es.type_defs import AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef

def get_value() -> AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef:
    return {
        "CrossClusterSearchConnectionId": ...,