Skip to content

Paginators#

Index > ElasticsearchService > Paginators

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

DescribeReservedElasticsearchInstanceOfferingsPaginator#

Type annotations and code completion for boto3.client("es").get_paginator("describe_reserved_elasticsearch_instance_offerings"). boto3 documentation

# 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")
# DescribeReservedElasticsearchInstanceOfferingsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_es.paginator import DescribeReservedElasticsearchInstanceOfferingsPaginator

session = Session()

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

paginate#

Type annotations and code completion for DescribeReservedElasticsearchInstanceOfferingsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ReservedElasticsearchInstanceOfferingId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeReservedElasticsearchInstanceOfferingsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeReservedElasticsearchInstanceOfferingsRequestDescribeReservedElasticsearchInstanceOfferingsPaginateTypeDef = {  # (1)
    "ReservedElasticsearchInstanceOfferingId": ...,
}

parent.paginate(**kwargs)
  1. See DescribeReservedElasticsearchInstanceOfferingsRequestDescribeReservedElasticsearchInstanceOfferingsPaginateTypeDef

DescribeReservedElasticsearchInstancesPaginator#

Type annotations and code completion for boto3.client("es").get_paginator("describe_reserved_elasticsearch_instances"). boto3 documentation

# DescribeReservedElasticsearchInstancesPaginator usage example

from boto3.session import Session

from mypy_boto3_es.paginator import DescribeReservedElasticsearchInstancesPaginator

def get_describe_reserved_elasticsearch_instances_paginator() -> DescribeReservedElasticsearchInstancesPaginator:
    return Session().client("es").get_paginator("describe_reserved_elasticsearch_instances")
# DescribeReservedElasticsearchInstancesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_es.paginator import DescribeReservedElasticsearchInstancesPaginator

session = Session()

client = Session().client("es")  # (1)
paginator: DescribeReservedElasticsearchInstancesPaginator = client.get_paginator("describe_reserved_elasticsearch_instances")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElasticsearchServiceClient
  2. paginator: DescribeReservedElasticsearchInstancesPaginator
  3. item: DescribeReservedElasticsearchInstancesResponseTypeDef

paginate#

Type annotations and code completion for DescribeReservedElasticsearchInstancesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ReservedElasticsearchInstanceId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeReservedElasticsearchInstancesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeReservedElasticsearchInstancesResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeReservedElasticsearchInstancesRequestDescribeReservedElasticsearchInstancesPaginateTypeDef = {  # (1)
    "ReservedElasticsearchInstanceId": ...,
}

parent.paginate(**kwargs)
  1. See DescribeReservedElasticsearchInstancesRequestDescribeReservedElasticsearchInstancesPaginateTypeDef

GetUpgradeHistoryPaginator#

Type annotations and code completion for boto3.client("es").get_paginator("get_upgrade_history"). boto3 documentation

# GetUpgradeHistoryPaginator usage example

from boto3.session import Session

from mypy_boto3_es.paginator import GetUpgradeHistoryPaginator

def get_get_upgrade_history_paginator() -> GetUpgradeHistoryPaginator:
    return Session().client("es").get_paginator("get_upgrade_history")
# GetUpgradeHistoryPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_es.paginator import GetUpgradeHistoryPaginator

session = Session()

client = Session().client("es")  # (1)
paginator: GetUpgradeHistoryPaginator = client.get_paginator("get_upgrade_history")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElasticsearchServiceClient
  2. paginator: GetUpgradeHistoryPaginator
  3. item: GetUpgradeHistoryResponseTypeDef

paginate#

Type annotations and code completion for GetUpgradeHistoryPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DomainName: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[GetUpgradeHistoryResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See GetUpgradeHistoryResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: GetUpgradeHistoryRequestGetUpgradeHistoryPaginateTypeDef = {  # (1)
    "DomainName": ...,
}

parent.paginate(**kwargs)
  1. See GetUpgradeHistoryRequestGetUpgradeHistoryPaginateTypeDef

ListElasticsearchInstanceTypesPaginator#

Type annotations and code completion for boto3.client("es").get_paginator("list_elasticsearch_instance_types"). boto3 documentation

# ListElasticsearchInstanceTypesPaginator usage example

from boto3.session import Session

from mypy_boto3_es.paginator import ListElasticsearchInstanceTypesPaginator

def get_list_elasticsearch_instance_types_paginator() -> ListElasticsearchInstanceTypesPaginator:
    return Session().client("es").get_paginator("list_elasticsearch_instance_types")
# ListElasticsearchInstanceTypesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_es.paginator import ListElasticsearchInstanceTypesPaginator

session = Session()

client = Session().client("es")  # (1)
paginator: ListElasticsearchInstanceTypesPaginator = client.get_paginator("list_elasticsearch_instance_types")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElasticsearchServiceClient
  2. paginator: ListElasticsearchInstanceTypesPaginator
  3. item: ListElasticsearchInstanceTypesResponseTypeDef

paginate#

Type annotations and code completion for ListElasticsearchInstanceTypesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ElasticsearchVersion: str,
    DomainName: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListElasticsearchInstanceTypesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListElasticsearchInstanceTypesResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListElasticsearchInstanceTypesRequestListElasticsearchInstanceTypesPaginateTypeDef = {  # (1)
    "ElasticsearchVersion": ...,
}

parent.paginate(**kwargs)
  1. See ListElasticsearchInstanceTypesRequestListElasticsearchInstanceTypesPaginateTypeDef

ListElasticsearchVersionsPaginator#

Type annotations and code completion for boto3.client("es").get_paginator("list_elasticsearch_versions"). boto3 documentation

# ListElasticsearchVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_es.paginator import ListElasticsearchVersionsPaginator

def get_list_elasticsearch_versions_paginator() -> ListElasticsearchVersionsPaginator:
    return Session().client("es").get_paginator("list_elasticsearch_versions")
# ListElasticsearchVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_es.paginator import ListElasticsearchVersionsPaginator

session = Session()

client = Session().client("es")  # (1)
paginator: ListElasticsearchVersionsPaginator = client.get_paginator("list_elasticsearch_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElasticsearchServiceClient
  2. paginator: ListElasticsearchVersionsPaginator
  3. item: ListElasticsearchVersionsResponseTypeDef

paginate#

Type annotations and code completion for ListElasticsearchVersionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[ListElasticsearchVersionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ListElasticsearchVersionsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: ListElasticsearchVersionsRequestListElasticsearchVersionsPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

parent.paginate(**kwargs)
  1. See ListElasticsearchVersionsRequestListElasticsearchVersionsPaginateTypeDef