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 DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef

DescribeCacheSecurityGroupsPaginator#

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

# DescribeCacheSecurityGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheSecurityGroupsPaginator

def get_describe_cache_security_groups_paginator() -> DescribeCacheSecurityGroupsPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_security_groups")
# DescribeCacheSecurityGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheSecurityGroupsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeCacheSecurityGroupsPaginator = client.get_paginator("describe_cache_security_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeCacheSecurityGroupsPaginator
  3. item: CacheSecurityGroupMessageTypeDef

paginate#

Type annotations and code completion for DescribeCacheSecurityGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef = {  # (1)
    "CacheSecurityGroupName": ...,
}

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

DescribeCacheSubnetGroupsPaginator#

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

# DescribeCacheSubnetGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheSubnetGroupsPaginator

def get_describe_cache_subnet_groups_paginator() -> DescribeCacheSubnetGroupsPaginator:
    return Session().client("elasticache").get_paginator("describe_cache_subnet_groups")
# DescribeCacheSubnetGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeCacheSubnetGroupsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeCacheSubnetGroupsPaginator = client.get_paginator("describe_cache_subnet_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeCacheSubnetGroupsPaginator
  3. item: CacheSubnetGroupMessageTypeDef

paginate#

Type annotations and code completion for DescribeCacheSubnetGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef = {  # (1)
    "CacheSubnetGroupName": ...,
}

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

DescribeEngineDefaultParametersPaginator#

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

# DescribeEngineDefaultParametersPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeEngineDefaultParametersPaginator

def get_describe_engine_default_parameters_paginator() -> DescribeEngineDefaultParametersPaginator:
    return Session().client("elasticache").get_paginator("describe_engine_default_parameters")
# DescribeEngineDefaultParametersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeEngineDefaultParametersPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeEngineDefaultParametersPaginator = client.get_paginator("describe_engine_default_parameters")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeEngineDefaultParametersPaginator
  3. item: DescribeEngineDefaultParametersResultTypeDef

paginate#

Type annotations and code completion for DescribeEngineDefaultParametersPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef = {  # (1)
    "CacheParameterGroupFamily": ...,
}

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

DescribeEventsPaginator#

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

# DescribeEventsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeEventsPaginator

def get_describe_events_paginator() -> DescribeEventsPaginator:
    return Session().client("elasticache").get_paginator("describe_events")
# DescribeEventsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeEventsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeEventsPaginator = client.get_paginator("describe_events")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeEventsPaginator
  3. item: EventsMessageTypeDef

paginate#

Type annotations and code completion for DescribeEventsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    SourceIdentifier: str = ...,
    SourceType: SourceTypeType = ...,  # (1)
    StartTime: Union[datetime, str] = ...,
    EndTime: Union[datetime, str] = ...,
    Duration: int = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[EventsMessageTypeDef]:  # (3)
    ...
  1. See SourceTypeType
  2. See PaginatorConfigTypeDef
  3. See EventsMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeEventsMessageDescribeEventsPaginateTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

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

DescribeGlobalReplicationGroupsPaginator#

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

# DescribeGlobalReplicationGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeGlobalReplicationGroupsPaginator

def get_describe_global_replication_groups_paginator() -> DescribeGlobalReplicationGroupsPaginator:
    return Session().client("elasticache").get_paginator("describe_global_replication_groups")
# DescribeGlobalReplicationGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeGlobalReplicationGroupsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeGlobalReplicationGroupsPaginator = client.get_paginator("describe_global_replication_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeGlobalReplicationGroupsPaginator
  3. item: DescribeGlobalReplicationGroupsResultTypeDef

paginate#

Type annotations and code completion for DescribeGlobalReplicationGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
}

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

DescribeReplicationGroupsPaginator#

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

# DescribeReplicationGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeReplicationGroupsPaginator

def get_describe_replication_groups_paginator() -> DescribeReplicationGroupsPaginator:
    return Session().client("elasticache").get_paginator("describe_replication_groups")
# DescribeReplicationGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeReplicationGroupsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeReplicationGroupsPaginator = client.get_paginator("describe_replication_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeReplicationGroupsPaginator
  3. item: ReplicationGroupMessageTypeDef

paginate#

Type annotations and code completion for DescribeReplicationGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

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

DescribeReservedCacheNodesPaginator#

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

# DescribeReservedCacheNodesPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeReservedCacheNodesPaginator

def get_describe_reserved_cache_nodes_paginator() -> DescribeReservedCacheNodesPaginator:
    return Session().client("elasticache").get_paginator("describe_reserved_cache_nodes")
# DescribeReservedCacheNodesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elasticache.paginator import DescribeReservedCacheNodesPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeReservedCacheNodesPaginator = client.get_paginator("describe_reserved_cache_nodes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: