Paginators

Index > RecycleBin > Paginators

Auto-generated documentation for RecycleBin type annotations stubs module types-boto3-rbin.

ListRulesPaginator

Type annotations and code completion for boto3.client("rbin").get_paginator("list_rules"). boto3 documentation

# ListRulesPaginator usage example

from boto3.session import Session

from types_boto3_rbin.paginator import ListRulesPaginator

def get_list_rules_paginator() -> ListRulesPaginator:
    return Session().client("rbin").get_paginator("list_rules")

# ListRulesPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_rbin.paginator import ListRulesPaginator

session = Session()

client = Session().client("rbin")  # (1)
paginator: ListRulesPaginator = client.get_paginator("list_rules")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: RecycleBinClient
2. paginator: ListRulesPaginator
3. item: PageIterator[ListRulesResponseTypeDef]

paginate

Type annotations and code completion for ListRulesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ResourceType: ResourceTypeType,  # (1)
    ResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (2)
    LockState: LockStateType = ...,  # (3)
    ExcludeResourceTags: Sequence[ResourceTagTypeDef] = ...,  # (2)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (5)
) -> botocore.paginate.PageIterator[ListRulesResponseTypeDef]:  # (6)
    ...

1. See ResourceTypeType
2. See Sequence[ResourceTagTypeDef]
3. See LockStateType
4. See Sequence[ResourceTagTypeDef]
5. See PaginatorConfigTypeDef
6. See PageIterator[ListRulesResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListRulesRequestPaginateTypeDef = {  # (1)
    "ResourceType": ...,
}

parent.paginate(**kwargs)

1. See ListRulesRequestPaginateTypeDef