Skip to content

Paginators#

Index > ElastiCache > Paginators

Auto-generated documentation for ElastiCache type annotations stubs module mypy-boto3-elasticache.

DescribeCacheClustersPaginator#

Type annotations and code completion for boto3.client("elasticache").get_paginator("describe_cache_clusters"). boto3 documentation

# DescribeCacheClustersPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheClustersPaginator

def get_describe_cache_clusters_paginator() -> DescribeCacheClustersPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_clusters")
# DescribeCacheClustersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheClustersPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeCacheClustersPaginator = client.get_paginator("describe_cache_clusters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeCacheClustersPaginator
  3. item: CacheClusterMessageTypeDef

paginate#

Type annotations and code completion for DescribeCacheClustersPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef = {  # (1)
    "CacheClusterId": ...,
}

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

DescribeCacheEngineVersionsPaginator#

Type annotations and code completion for boto3.client("elasticache").get_paginator("describe_cache_engine_versions"). boto3 documentation

# DescribeCacheEngineVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheEngineVersionsPaginator

def get_describe_cache_engine_versions_paginator() -> DescribeCacheEngineVersionsPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_engine_versions")
# DescribeCacheEngineVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheEngineVersionsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeCacheEngineVersionsPaginator = client.get_paginator("describe_cache_engine_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeCacheEngineVersionsPaginator
  3. item: CacheEngineVersionMessageTypeDef

paginate#

Type annotations and code completion for DescribeCacheEngineVersionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Engine: str = ...,
    EngineVersion: str = ...,
    CacheParameterGroupFamily: str = ...,
    DefaultOnly: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[CacheEngineVersionMessageTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See CacheEngineVersionMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef = {  # (1)
    "Engine": ...,
}

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

DescribeCacheParameterGroupsPaginator#

Type annotations and code completion for boto3.client("elasticache").get_paginator("describe_cache_parameter_groups"). boto3 documentation

# DescribeCacheParameterGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheParameterGroupsPaginator

def get_describe_cache_parameter_groups_paginator() -> DescribeCacheParameterGroupsPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_parameter_groups")
# DescribeCacheParameterGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheParameterGroupsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeCacheParameterGroupsPaginator = client.get_paginator("describe_cache_parameter_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeCacheParameterGroupsPaginator
  3. item: CacheParameterGroupsMessageTypeDef

paginate#

Type annotations and code completion for DescribeCacheParameterGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

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

DescribeCacheParametersPaginator#

Type annotations and code completion for boto3.client("elasticache").get_paginator("describe_cache_parameters"). boto3 documentation

# DescribeCacheParametersPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheParametersPaginator

def get_describe_cache_parameters_paginator() -> DescribeCacheParametersPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_parameters")
# DescribeCacheParametersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheParametersPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeCacheParametersPaginator = client.get_paginator("describe_cache_parameters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeCacheParametersPaginator
  3. item: CacheParameterGroupDetailsTypeDef

paginate#

Type annotations and code completion for DescribeCacheParametersPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

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