Paginators#
Index > ElastiCache > Paginators
Auto-generated documentation for ElastiCache type annotations stubs module types-aiobotocore-elasticache.
DescribeCacheClustersPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_cache_clusters")
.
boto3 documentation
# DescribeCacheClustersPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeCacheClustersPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeCacheClustersPaginator = client.get_paginator("describe_cache_clusters") # (2)
async for item in paginator.paginate(...):
item: CacheClusterMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeCacheClustersPaginator
- 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)
) -> AsyncIterator[CacheClusterMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCacheClustersMessageDescribeCacheClustersPaginateTypeDef = { # (1)
"CacheClusterId": ...,
}
parent.paginate(**kwargs)
DescribeCacheEngineVersionsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_cache_engine_versions")
.
boto3 documentation
# DescribeCacheEngineVersionsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeCacheEngineVersionsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeCacheEngineVersionsPaginator = client.get_paginator("describe_cache_engine_versions") # (2)
async for item in paginator.paginate(...):
item: CacheEngineVersionMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeCacheEngineVersionsPaginator
- 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)
) -> AsyncIterator[CacheEngineVersionMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCacheEngineVersionsMessageDescribeCacheEngineVersionsPaginateTypeDef = { # (1)
"Engine": ...,
}
parent.paginate(**kwargs)
DescribeCacheParameterGroupsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_cache_parameter_groups")
.
boto3 documentation
# DescribeCacheParameterGroupsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeCacheParameterGroupsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeCacheParameterGroupsPaginator = client.get_paginator("describe_cache_parameter_groups") # (2)
async for item in paginator.paginate(...):
item: CacheParameterGroupsMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeCacheParameterGroupsPaginator
- item: CacheParameterGroupsMessageTypeDef
paginate#
Type annotations and code completion for DescribeCacheParameterGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
CacheParameterGroupName: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[CacheParameterGroupsMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCacheParameterGroupsMessageDescribeCacheParameterGroupsPaginateTypeDef = { # (1)
"CacheParameterGroupName": ...,
}
parent.paginate(**kwargs)
DescribeCacheParametersPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_cache_parameters")
.
boto3 documentation
# DescribeCacheParametersPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeCacheParametersPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeCacheParametersPaginator = client.get_paginator("describe_cache_parameters") # (2)
async for item in paginator.paginate(...):
item: CacheParameterGroupDetailsTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeCacheParametersPaginator
- 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)
) -> AsyncIterator[CacheParameterGroupDetailsTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCacheParametersMessageDescribeCacheParametersPaginateTypeDef = { # (1)
"CacheParameterGroupName": ...,
}
parent.paginate(**kwargs)
DescribeCacheSecurityGroupsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_cache_security_groups")
.
boto3 documentation
# DescribeCacheSecurityGroupsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeCacheSecurityGroupsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeCacheSecurityGroupsPaginator = client.get_paginator("describe_cache_security_groups") # (2)
async for item in paginator.paginate(...):
item: CacheSecurityGroupMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeCacheSecurityGroupsPaginator
- item: CacheSecurityGroupMessageTypeDef
paginate#
Type annotations and code completion for DescribeCacheSecurityGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
CacheSecurityGroupName: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[CacheSecurityGroupMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCacheSecurityGroupsMessageDescribeCacheSecurityGroupsPaginateTypeDef = { # (1)
"CacheSecurityGroupName": ...,
}
parent.paginate(**kwargs)
DescribeCacheSubnetGroupsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_cache_subnet_groups")
.
boto3 documentation
# DescribeCacheSubnetGroupsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeCacheSubnetGroupsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeCacheSubnetGroupsPaginator = client.get_paginator("describe_cache_subnet_groups") # (2)
async for item in paginator.paginate(...):
item: CacheSubnetGroupMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeCacheSubnetGroupsPaginator
- item: CacheSubnetGroupMessageTypeDef
paginate#
Type annotations and code completion for DescribeCacheSubnetGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
CacheSubnetGroupName: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[CacheSubnetGroupMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeCacheSubnetGroupsMessageDescribeCacheSubnetGroupsPaginateTypeDef = { # (1)
"CacheSubnetGroupName": ...,
}
parent.paginate(**kwargs)
DescribeEngineDefaultParametersPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_engine_default_parameters")
.
boto3 documentation
# DescribeEngineDefaultParametersPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeEngineDefaultParametersPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeEngineDefaultParametersPaginator = client.get_paginator("describe_engine_default_parameters") # (2)
async for item in paginator.paginate(...):
item: DescribeEngineDefaultParametersResultTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeEngineDefaultParametersPaginator
- item: DescribeEngineDefaultParametersResultTypeDef
paginate#
Type annotations and code completion for DescribeEngineDefaultParametersPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
CacheParameterGroupFamily: str,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[DescribeEngineDefaultParametersResultTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeEngineDefaultParametersMessageDescribeEngineDefaultParametersPaginateTypeDef = { # (1)
"CacheParameterGroupFamily": ...,
}
parent.paginate(**kwargs)
DescribeEventsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_events")
.
boto3 documentation
# DescribeEventsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeEventsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeEventsPaginator = client.get_paginator("describe_events") # (2)
async for item in paginator.paginate(...):
item: EventsMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeEventsPaginator
- 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)
) -> AsyncIterator[EventsMessageTypeDef]: # (3)
...
- See SourceTypeType
- See PaginatorConfigTypeDef
- See EventsMessageTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeEventsMessageDescribeEventsPaginateTypeDef = { # (1)
"SourceIdentifier": ...,
}
parent.paginate(**kwargs)
DescribeGlobalReplicationGroupsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_global_replication_groups")
.
boto3 documentation
# DescribeGlobalReplicationGroupsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeGlobalReplicationGroupsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeGlobalReplicationGroupsPaginator = client.get_paginator("describe_global_replication_groups") # (2)
async for item in paginator.paginate(...):
item: DescribeGlobalReplicationGroupsResultTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeGlobalReplicationGroupsPaginator
- 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)
) -> AsyncIterator[DescribeGlobalReplicationGroupsResultTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeGlobalReplicationGroupsMessageDescribeGlobalReplicationGroupsPaginateTypeDef = { # (1)
"GlobalReplicationGroupId": ...,
}
parent.paginate(**kwargs)
DescribeReplicationGroupsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_replication_groups")
.
boto3 documentation
# DescribeReplicationGroupsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeReplicationGroupsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeReplicationGroupsPaginator = client.get_paginator("describe_replication_groups") # (2)
async for item in paginator.paginate(...):
item: ReplicationGroupMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeReplicationGroupsPaginator
- item: ReplicationGroupMessageTypeDef
paginate#
Type annotations and code completion for DescribeReplicationGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
ReplicationGroupId: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[ReplicationGroupMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeReplicationGroupsMessageDescribeReplicationGroupsPaginateTypeDef = { # (1)
"ReplicationGroupId": ...,
}
parent.paginate(**kwargs)
DescribeReservedCacheNodesPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_reserved_cache_nodes")
.
boto3 documentation
# DescribeReservedCacheNodesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeReservedCacheNodesPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeReservedCacheNodesPaginator = client.get_paginator("describe_reserved_cache_nodes") # (2)
async for item in paginator.paginate(...):
item: ReservedCacheNodeMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeReservedCacheNodesPaginator
- 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)
) -> AsyncIterator[ReservedCacheNodeMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeReservedCacheNodesMessageDescribeReservedCacheNodesPaginateTypeDef = { # (1)
"ReservedCacheNodeId": ...,
}
parent.paginate(**kwargs)
DescribeReservedCacheNodesOfferingsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_reserved_cache_nodes_offerings")
.
boto3 documentation
# DescribeReservedCacheNodesOfferingsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeReservedCacheNodesOfferingsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeReservedCacheNodesOfferingsPaginator = client.get_paginator("describe_reserved_cache_nodes_offerings") # (2)
async for item in paginator.paginate(...):
item: ReservedCacheNodesOfferingMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeReservedCacheNodesOfferingsPaginator
- 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)
) -> AsyncIterator[ReservedCacheNodesOfferingMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeReservedCacheNodesOfferingsMessageDescribeReservedCacheNodesOfferingsPaginateTypeDef = { # (1)
"ReservedCacheNodesOfferingId": ...,
}
parent.paginate(**kwargs)
DescribeServiceUpdatesPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_service_updates")
.
boto3 documentation
# DescribeServiceUpdatesPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeServiceUpdatesPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeServiceUpdatesPaginator = client.get_paginator("describe_service_updates") # (2)
async for item in paginator.paginate(...):
item: ServiceUpdatesMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeServiceUpdatesPaginator
- 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)
) -> AsyncIterator[ServiceUpdatesMessageTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeServiceUpdatesMessageDescribeServiceUpdatesPaginateTypeDef = { # (1)
"ServiceUpdateName": ...,
}
parent.paginate(**kwargs)
DescribeSnapshotsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_snapshots")
.
boto3 documentation
# DescribeSnapshotsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeSnapshotsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeSnapshotsPaginator = client.get_paginator("describe_snapshots") # (2)
async for item in paginator.paginate(...):
item: DescribeSnapshotsListMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeSnapshotsPaginator
- 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)
) -> AsyncIterator[DescribeSnapshotsListMessageTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeSnapshotsMessageDescribeSnapshotsPaginateTypeDef = { # (1)
"ReplicationGroupId": ...,
}
parent.paginate(**kwargs)
DescribeUpdateActionsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_update_actions")
.
boto3 documentation
# DescribeUpdateActionsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeUpdateActionsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeUpdateActionsPaginator = client.get_paginator("describe_update_actions") # (2)
async for item in paginator.paginate(...):
item: UpdateActionsMessageTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeUpdateActionsPaginator
- 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)
) -> AsyncIterator[UpdateActionsMessageTypeDef]: # (5)
...
- See ServiceUpdateStatusType
- See TimeRangeFilterTypeDef
- See UpdateActionStatusType
- See PaginatorConfigTypeDef
- See UpdateActionsMessageTypeDef
# paginate method usage example with argument unpacking
kwargs: DescribeUpdateActionsMessageDescribeUpdateActionsPaginateTypeDef = { # (1)
"ServiceUpdateName": ...,
}
parent.paginate(**kwargs)
DescribeUserGroupsPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_user_groups")
.
boto3 documentation
# DescribeUserGroupsPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeUserGroupsPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeUserGroupsPaginator = client.get_paginator("describe_user_groups") # (2)
async for item in paginator.paginate(...):
item: DescribeUserGroupsResultTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeUserGroupsPaginator
- item: DescribeUserGroupsResultTypeDef
paginate#
Type annotations and code completion for DescribeUserGroupsPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
UserGroupId: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (1)
) -> AsyncIterator[DescribeUserGroupsResultTypeDef]: # (2)
...
# paginate method usage example with argument unpacking
kwargs: DescribeUserGroupsMessageDescribeUserGroupsPaginateTypeDef = { # (1)
"UserGroupId": ...,
}
parent.paginate(**kwargs)
DescribeUsersPaginator#
Type annotations and code completion for session.create_client("elasticache").get_paginator("describe_users")
.
boto3 documentation
# DescribeUsersPaginator usage example
from aiobotocore.session import get_session
from types_aiobotocore_elasticache.paginator import DescribeUsersPaginator
session = get_session()
async with session.create_client("elasticache") as client: # (1)
paginator: DescribeUsersPaginator = client.get_paginator("describe_users") # (2)
async for item in paginator.paginate(...):
item: DescribeUsersResultTypeDef
print(item) # (3)
- client: ElastiCacheClient
- paginator: DescribeUsersPaginator
- 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)
) -> AsyncIterator[DescribeUsersResultTypeDef]: # (3)
...
# paginate method usage example with argument unpacking
kwargs: DescribeUsersMessageDescribeUsersPaginateTypeDef = { # (1)
"Engine": ...,
}
parent.paginate(**kwargs)