Skip to content

ElasticsearchService module

Index > ElasticsearchService

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

How to install

From PyPI with pip

Install types-aioboto3 for ElasticsearchService service.

# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-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.client("es") as ElasticsearchServiceClient boto3 documentation

Usage example
from aioboto3.session import Session

from types_aiobotocore_es.client import ElasticsearchServiceClient


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

Paginators

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

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.

Usage example
from types_aiobotocore_es.literals import AutoTuneDesiredStateType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from types_aiobotocore_es.type_defs import AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef

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