Skip to content

Paginators#

Index > ElastiCache > Paginators

Auto-generated documentation for ElastiCache type annotations stubs module types-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 types_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 types_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: DescribeCacheClustersMessagePaginateTypeDef = {  # (1)
    "CacheClusterId": ...,
}

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

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 types_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 types_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: DescribeCacheEngineVersionsMessagePaginateTypeDef = {  # (1)
    "Engine": ...,
}

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

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 types_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 types_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: DescribeCacheParameterGroupsMessagePaginateTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

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

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 types_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 types_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: DescribeCacheParametersMessagePaginateTypeDef = {  # (1)
    "CacheParameterGroupName": ...,
}

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

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 types_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 types_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: DescribeCacheSecurityGroupsMessagePaginateTypeDef = {  # (1)
    "CacheSecurityGroupName": ...,
}

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

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 types_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 types_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: DescribeCacheSubnetGroupsMessagePaginateTypeDef = {  # (1)
    "CacheSubnetGroupName": ...,
}

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

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 types_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 types_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: DescribeEngineDefaultParametersMessagePaginateTypeDef = {  # (1)
    "CacheParameterGroupFamily": ...,
}

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

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 types_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 types_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: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    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: DescribeEventsMessagePaginateTypeDef = {  # (1)
    "SourceIdentifier": ...,
}

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

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 types_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 types_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: DescribeGlobalReplicationGroupsMessagePaginateTypeDef = {  # (1)
    "GlobalReplicationGroupId": ...,
}

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

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 types_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 types_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: DescribeReplicationGroupsMessagePaginateTypeDef = {  # (1)
    "ReplicationGroupId": ...,
}

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

DescribeReservedCacheNodesOfferingsPaginator#

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

# DescribeReservedCacheNodesOfferingsPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeReservedCacheNodesOfferingsPaginator

def get_describe_reserved_cache_nodes_offerings_paginator() -> DescribeReservedCacheNodesOfferingsPaginator:
    return Session().client("elasticache").get_paginator("describe_reserved_cache_nodes_offerings")
# DescribeReservedCacheNodesOfferingsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeReservedCacheNodesOfferingsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeReservedCacheNodesOfferingsPaginator = client.get_paginator("describe_reserved_cache_nodes_offerings")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeReservedCacheNodesOfferingsPaginator
  3. item: ReservedCacheNodesOfferingMessageTypeDef

paginate#

Type annotations and code completion for DescribeReservedCacheNodesOfferingsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ReservedCacheNodesOfferingId: str = ...,
    CacheNodeType: str = ...,
    Duration: str = ...,
    ProductDescription: str = ...,
    OfferingType: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ReservedCacheNodesOfferingMessageTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ReservedCacheNodesOfferingMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeReservedCacheNodesOfferingsMessagePaginateTypeDef = {  # (1)
    "ReservedCacheNodesOfferingId": ...,
}

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

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 types_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 types_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: ElastiCacheClient
  2. paginator: DescribeReservedCacheNodesPaginator
  3. item: ReservedCacheNodeMessageTypeDef

paginate#

Type annotations and code completion for DescribeReservedCacheNodesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ReservedCacheNodeId: str = ...,
    ReservedCacheNodesOfferingId: str = ...,
    CacheNodeType: str = ...,
    Duration: str = ...,
    ProductDescription: str = ...,
    OfferingType: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ReservedCacheNodeMessageTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See ReservedCacheNodeMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeReservedCacheNodesMessagePaginateTypeDef = {  # (1)
    "ReservedCacheNodeId": ...,
}

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

DescribeServerlessCacheSnapshotsPaginator#

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

# DescribeServerlessCacheSnapshotsPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeServerlessCacheSnapshotsPaginator

def get_describe_serverless_cache_snapshots_paginator() -> DescribeServerlessCacheSnapshotsPaginator:
    return Session().client("elasticache").get_paginator("describe_serverless_cache_snapshots")
# DescribeServerlessCacheSnapshotsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeServerlessCacheSnapshotsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeServerlessCacheSnapshotsPaginator = client.get_paginator("describe_serverless_cache_snapshots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeServerlessCacheSnapshotsPaginator
  3. item: DescribeServerlessCacheSnapshotsResponseTypeDef

paginate#

Type annotations and code completion for DescribeServerlessCacheSnapshotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ServerlessCacheName: str = ...,
    ServerlessCacheSnapshotName: str = ...,
    SnapshotType: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeServerlessCacheSnapshotsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeServerlessCacheSnapshotsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeServerlessCacheSnapshotsRequestPaginateTypeDef = {  # (1)
    "ServerlessCacheName": ...,
}

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

DescribeServerlessCachesPaginator#

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

# DescribeServerlessCachesPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeServerlessCachesPaginator

def get_describe_serverless_caches_paginator() -> DescribeServerlessCachesPaginator:
    return Session().client("elasticache").get_paginator("describe_serverless_caches")
# DescribeServerlessCachesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeServerlessCachesPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeServerlessCachesPaginator = client.get_paginator("describe_serverless_caches")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeServerlessCachesPaginator
  3. item: DescribeServerlessCachesResponseTypeDef

paginate#

Type annotations and code completion for DescribeServerlessCachesPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeServerlessCachesRequestPaginateTypeDef = {  # (1)
    "ServerlessCacheName": ...,
}

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

DescribeServiceUpdatesPaginator#

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

# DescribeServiceUpdatesPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeServiceUpdatesPaginator

def get_describe_service_updates_paginator() -> DescribeServiceUpdatesPaginator:
    return Session().client("elasticache").get_paginator("describe_service_updates")
# DescribeServiceUpdatesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeServiceUpdatesPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeServiceUpdatesPaginator = client.get_paginator("describe_service_updates")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeServiceUpdatesPaginator
  3. item: ServiceUpdatesMessageTypeDef

paginate#

Type annotations and code completion for DescribeServiceUpdatesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ServiceUpdateName: str = ...,
    ServiceUpdateStatus: Sequence[ServiceUpdateStatusType] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[ServiceUpdatesMessageTypeDef]:  # (3)
    ...
  1. See ServiceUpdateStatusType
  2. See PaginatorConfigTypeDef
  3. See ServiceUpdatesMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeServiceUpdatesMessagePaginateTypeDef = {  # (1)
    "ServiceUpdateName": ...,
}

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

DescribeSnapshotsPaginator#

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

# DescribeSnapshotsPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeSnapshotsPaginator

def get_describe_snapshots_paginator() -> DescribeSnapshotsPaginator:
    return Session().client("elasticache").get_paginator("describe_snapshots")
# DescribeSnapshotsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeSnapshotsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeSnapshotsPaginator
  3. item: DescribeSnapshotsListMessageTypeDef

paginate#

Type annotations and code completion for DescribeSnapshotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ReplicationGroupId: str = ...,
    CacheClusterId: str = ...,
    SnapshotName: str = ...,
    SnapshotSource: str = ...,
    ShowNodeGroupConfig: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[DescribeSnapshotsListMessageTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeSnapshotsListMessageTypeDef 
# paginate method usage example with argument unpacking

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

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

DescribeUpdateActionsPaginator#

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

# DescribeUpdateActionsPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeUpdateActionsPaginator

def get_describe_update_actions_paginator() -> DescribeUpdateActionsPaginator:
    return Session().client("elasticache").get_paginator("describe_update_actions")
# DescribeUpdateActionsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeUpdateActionsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeUpdateActionsPaginator = client.get_paginator("describe_update_actions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeUpdateActionsPaginator
  3. item: UpdateActionsMessageTypeDef

paginate#

Type annotations and code completion for DescribeUpdateActionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ServiceUpdateName: str = ...,
    ReplicationGroupIds: Sequence[str] = ...,
    CacheClusterIds: Sequence[str] = ...,
    Engine: str = ...,
    ServiceUpdateStatus: Sequence[ServiceUpdateStatusType] = ...,  # (1)
    ServiceUpdateTimeRange: TimeRangeFilterTypeDef = ...,  # (2)
    UpdateActionStatus: Sequence[UpdateActionStatusType] = ...,  # (3)
    ShowNodeLevelUpdateStatus: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> PageIterator[UpdateActionsMessageTypeDef]:  # (5)
    ...
  1. See ServiceUpdateStatusType
  2. See TimeRangeFilterTypeDef
  3. See UpdateActionStatusType
  4. See PaginatorConfigTypeDef
  5. See UpdateActionsMessageTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeUpdateActionsMessagePaginateTypeDef = {  # (1)
    "ServiceUpdateName": ...,
}

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

DescribeUserGroupsPaginator#

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

# DescribeUserGroupsPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeUserGroupsPaginator

def get_describe_user_groups_paginator() -> DescribeUserGroupsPaginator:
    return Session().client("elasticache").get_paginator("describe_user_groups")
# DescribeUserGroupsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeUserGroupsPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeUserGroupsPaginator = client.get_paginator("describe_user_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeUserGroupsPaginator
  3. item: DescribeUserGroupsResultTypeDef

paginate#

Type annotations and code completion for DescribeUserGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeUserGroupsMessagePaginateTypeDef = {  # (1)
    "UserGroupId": ...,
}

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

DescribeUsersPaginator#

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

# DescribeUsersPaginator usage example

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeUsersPaginator

def get_describe_users_paginator() -> DescribeUsersPaginator:
    return Session().client("elasticache").get_paginator("describe_users")
# DescribeUsersPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_elasticache.paginator import DescribeUsersPaginator

session = Session()

client = Session().client("elasticache")  # (1)
paginator: DescribeUsersPaginator = client.get_paginator("describe_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElastiCacheClient
  2. paginator: DescribeUsersPaginator
  3. item: DescribeUsersResultTypeDef

paginate#

Type annotations and code completion for DescribeUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Engine: str = ...,
    UserId: str = ...,
    Filters: Sequence[FilterTypeDef] = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> PageIterator[DescribeUsersResultTypeDef]:  # (3)
    ...
  1. See FilterTypeDef
  2. See PaginatorConfigTypeDef
  3. See DescribeUsersResultTypeDef 
# paginate method usage example with argument unpacking

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

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