Paginators

Index > EventBridgePipes > Paginators

Auto-generated documentation for EventBridgePipes type annotations stubs module types-boto3-pipes.

ListPipesPaginator

Type annotations and code completion for boto3.client("pipes").get_paginator("list_pipes"). boto3 documentation

# ListPipesPaginator usage example

from boto3.session import Session

from types_boto3_pipes.paginator import ListPipesPaginator

def get_list_pipes_paginator() -> ListPipesPaginator:
    return Session().client("pipes").get_paginator("list_pipes")

# ListPipesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_pipes.paginator import ListPipesPaginator

session = Session()

client = Session().client("pipes")  # (1)
paginator: ListPipesPaginator = client.get_paginator("list_pipes")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: EventBridgePipesClient
2. paginator: ListPipesPaginator
3. item: PageIterator[ListPipesResponseTypeDef]

paginate

Type annotations and code completion for ListPipesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    NamePrefix: str = ...,
    DesiredState: RequestedPipeStateType = ...,  # (1)
    CurrentState: PipeStateType = ...,  # (2)
    SourcePrefix: str = ...,
    TargetPrefix: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (3)
) -> botocore.paginate.PageIterator[ListPipesResponseTypeDef]:  # (4)
    ...

1. See RequestedPipeStateType
2. See PipeStateType
3. See PaginatorConfigTypeDef
4. See PageIterator[ListPipesResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListPipesRequestPaginateTypeDef = {  # (1)
    "NamePrefix": ...,
}

parent.paginate(**kwargs)

1. See ListPipesRequestPaginateTypeDef