Paginators

Index > Chime > Paginators

Auto-generated documentation for Chime type annotations stubs module types-boto3-chime.

ListAccountsPaginator

Type annotations and code completion for boto3.client("chime").get_paginator("list_accounts"). boto3 documentation

# ListAccountsPaginator usage example

from boto3.session import Session

from types_boto3_chime.paginator import ListAccountsPaginator

def get_list_accounts_paginator() -> ListAccountsPaginator:
    return Session().client("chime").get_paginator("list_accounts")

# ListAccountsPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_chime.paginator import ListAccountsPaginator

session = Session()

client = Session().client("chime")  # (1)
paginator: ListAccountsPaginator = client.get_paginator("list_accounts")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: ChimeClient
2. paginator: ListAccountsPaginator
3. item: PageIterator[ListAccountsResponseTypeDef]

paginate

Type annotations and code completion for ListAccountsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    Name: str = ...,
    UserEmail: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> botocore.paginate.PageIterator[ListAccountsResponseTypeDef]:  # (2)
    ...

1. See PaginatorConfigTypeDef
2. See PageIterator[ListAccountsResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListAccountsRequestPaginateTypeDef = {  # (1)
    "Name": ...,
}

parent.paginate(**kwargs)

1. See ListAccountsRequestPaginateTypeDef

ListUsersPaginator

Type annotations and code completion for boto3.client("chime").get_paginator("list_users"). boto3 documentation

# ListUsersPaginator usage example

from boto3.session import Session

from types_boto3_chime.paginator import ListUsersPaginator

def get_list_users_paginator() -> ListUsersPaginator:
    return Session().client("chime").get_paginator("list_users")

# ListUsersPaginator usage example with type annotations

from boto3.session import Session

from types_boto3_chime.paginator import ListUsersPaginator

session = Session()

client = Session().client("chime")  # (1)
paginator: ListUsersPaginator = client.get_paginator("list_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: ChimeClient
2. paginator: ListUsersPaginator
3. item: PageIterator[ListUsersResponseTypeDef]

paginate

Type annotations and code completion for ListUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    AccountId: str,
    UserEmail: str = ...,
    UserType: UserTypeType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListUsersResponseTypeDef]:  # (3)
    ...

1. See UserTypeType
2. See PaginatorConfigTypeDef
3. See PageIterator[ListUsersResponseTypeDef]

# paginate method usage example with argument unpacking

kwargs: ListUsersRequestPaginateTypeDef = {  # (1)
    "AccountId": ...,
}

parent.paginate(**kwargs)

1. See ListUsersRequestPaginateTypeDef