Paginators#
Index > EventBridgePipes > Paginators
Auto-generated documentation for EventBridgePipes type annotations stubs module types-aiobotocore-pipes.
ListPipesPaginator#
Type annotations and code completion for session.client("pipes").get_paginator("list_pipes")
.
boto3 documentation
# ListPipesPaginator usage example
from aioboto3.session import Session
from types_aiobotocore_pipes.paginator import ListPipesPaginator
session = Session()
session = get_session()
async with session.client("pipes") as client: # (1)
paginator: ListPipesPaginator = client.get_paginator("list_pipes") # (2)
async for item in paginator.paginate(...):
item: ListPipesResponseTypeDef
print(item) # (3)
- client: EventBridgePipesClient
- paginator: ListPipesPaginator
- item: ListPipesResponseTypeDef
paginate#
Type annotations and code completion for ListPipesPaginator.paginate
method.
# paginate method definition
def paginate(
self,
*,
CurrentState: PipeStateType = ..., # (1)
DesiredState: RequestedPipeStateType = ..., # (2)
NamePrefix: str = ...,
SourcePrefix: str = ...,
TargetPrefix: str = ...,
PaginationConfig: PaginatorConfigTypeDef = ..., # (3)
) -> AsyncIterator[ListPipesResponseTypeDef]: # (4)
...
- See PipeStateType
- See RequestedPipeStateType
- See PaginatorConfigTypeDef
- See ListPipesResponseTypeDef
# paginate method usage example with argument unpacking
kwargs: ListPipesRequestListPipesPaginateTypeDef = { # (1)
"CurrentState": ...,
}
parent.paginate(**kwargs)