Skip to content

Examples

Index > ElasticsearchService > Examples

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

Client

Implicit type annotations

Can be used with types-aioboto3[es] package installed.

Write your ElasticsearchService code as usual, type checking and code completion should work out of the box.

Client usage example
from aioboto3.session import Session


session = Session()

async with session.client("es") as client:  # (1)
    result = await client.accept_inbound_cross_cluster_search_connection()  # (2)
  1. client: ElasticsearchServiceClient
  2. result: AcceptInboundCrossClusterSearchConnectionResponseTypeDef
Paginator usage example
from aioboto3.session import Session


session = Session()

async with session.client("es") as client:  # (1)
    paginator = client.get_paginator("describe_reserved_elasticsearch_instance_offerings")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: ElasticsearchServiceClient
  2. paginator: DescribeReservedElasticsearchInstanceOfferingsPaginator
  3. item: DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef

Explicit type annotations

With types-aioboto3-lite[es] or a standalone types_aiobotocore_es package, you have to explicitly specify client: ElasticsearchServiceClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client usage example
from aioboto3.session import Session

from types_aiobotocore_es.client import ElasticsearchServiceClient
from types_aiobotocore_es.type_defs import AcceptInboundCrossClusterSearchConnectionResponseTypeDef
from types_aiobotocore_es.type_defs import AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef


session = Session()

client: ElasticsearchServiceClient
async with session.client("es") as client:  # (1)
    kwargs: AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef = {...}  # (2)
    result: AcceptInboundCrossClusterSearchConnectionResponseTypeDef = await client.accept_inbound_cross_cluster_search_connection(**kwargs)  # (3)
  1. client: ElasticsearchServiceClient
  2. kwargs: AcceptInboundCrossClusterSearchConnectionRequestRequestTypeDef
  3. result: AcceptInboundCrossClusterSearchConnectionResponseTypeDef
Paginator usage example
from aioboto3.session import Session

from types_aiobotocore_es.client import ElasticsearchServiceClient
from types_aiobotocore_es.paginator import DescribeReservedElasticsearchInstanceOfferingsPaginator
from types_aiobotocore_es.type_defs import DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef


session = Session()

client: ElasticsearchServiceClient
async with session.client("es") as client:  # (1)
    paginator: DescribeReservedElasticsearchInstanceOfferingsPaginator = client.get_paginator("describe_reserved_elasticsearch_instance_offerings")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef
        print(item)  # (3)
  1. client: ElasticsearchServiceClient
  2. paginator: DescribeReservedElasticsearchInstanceOfferingsPaginator
  3. item: DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef