Skip to content

Paginators#

Index > WickrAdminAPI > Paginators

Auto-generated documentation for WickrAdminAPI type annotations stubs module mypy-boto3-wickr.

ListBlockedGuestUsersPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_blocked_guest_users"). boto3 documentation

# ListBlockedGuestUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListBlockedGuestUsersPaginator

def get_list_blocked_guest_users_paginator() -> ListBlockedGuestUsersPaginator:
    return Session().client("wickr").get_paginator("list_blocked_guest_users")
# ListBlockedGuestUsersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListBlockedGuestUsersPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListBlockedGuestUsersPaginator = client.get_paginator("list_blocked_guest_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListBlockedGuestUsersPaginator
  3. item: PageIterator[ListBlockedGuestUsersResponseTypeDef]

paginate#

Type annotations and code completion for ListBlockedGuestUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    sortDirection: SortDirectionType = ...,  # (1)
    sortFields: str = ...,
    username: str = ...,
    admin: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListBlockedGuestUsersResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListBlockedGuestUsersResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListBlockedGuestUsersRequestPaginateTypeDef = {  # (1)
    "networkId": ...,
}

parent.paginate(**kwargs)
  1. See ListBlockedGuestUsersRequestPaginateTypeDef

ListBotsPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_bots"). boto3 documentation

# ListBotsPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListBotsPaginator

def get_list_bots_paginator() -> ListBotsPaginator:
    return Session().client("wickr").get_paginator("list_bots")
# ListBotsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListBotsPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListBotsPaginator = client.get_paginator("list_bots")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListBotsPaginator
  3. item: PageIterator[ListBotsResponseTypeDef]

paginate#

Type annotations and code completion for ListBotsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    displayName: str = ...,
    username: str = ...,
    status: int = ...,
    groupId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListBotsResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListBotsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListBotsRequestPaginateTypeDef = {  # (1)
    "networkId": ...,
}

parent.paginate(**kwargs)
  1. See ListBotsRequestPaginateTypeDef

ListDevicesForUserPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_devices_for_user"). boto3 documentation

# ListDevicesForUserPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListDevicesForUserPaginator

def get_list_devices_for_user_paginator() -> ListDevicesForUserPaginator:
    return Session().client("wickr").get_paginator("list_devices_for_user")
# ListDevicesForUserPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListDevicesForUserPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListDevicesForUserPaginator = client.get_paginator("list_devices_for_user")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListDevicesForUserPaginator
  3. item: PageIterator[ListDevicesForUserResponseTypeDef]

paginate#

Type annotations and code completion for ListDevicesForUserPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    userId: str,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListDevicesForUserResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListDevicesForUserResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListDevicesForUserRequestPaginateTypeDef = {  # (1)
    "networkId": ...,
    "userId": ...,
}

parent.paginate(**kwargs)
  1. See ListDevicesForUserRequestPaginateTypeDef

ListGuestUsersPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_guest_users"). boto3 documentation

# ListGuestUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListGuestUsersPaginator

def get_list_guest_users_paginator() -> ListGuestUsersPaginator:
    return Session().client("wickr").get_paginator("list_guest_users")
# ListGuestUsersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListGuestUsersPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListGuestUsersPaginator = client.get_paginator("list_guest_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListGuestUsersPaginator
  3. item: PageIterator[ListGuestUsersResponseTypeDef]

paginate#

Type annotations and code completion for ListGuestUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    sortDirection: SortDirectionType = ...,  # (1)
    sortFields: str = ...,
    username: str = ...,
    billingPeriod: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListGuestUsersResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListGuestUsersResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListGuestUsersRequestPaginateTypeDef = {  # (1)
    "networkId": ...,
}

parent.paginate(**kwargs)
  1. See ListGuestUsersRequestPaginateTypeDef

ListNetworksPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_networks"). boto3 documentation

# ListNetworksPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListNetworksPaginator

def get_list_networks_paginator() -> ListNetworksPaginator:
    return Session().client("wickr").get_paginator("list_networks")
# ListNetworksPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListNetworksPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListNetworksPaginator = client.get_paginator("list_networks")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListNetworksPaginator
  3. item: PageIterator[ListNetworksResponseTypeDef]

paginate#

Type annotations and code completion for ListNetworksPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListNetworksResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListNetworksResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListNetworksRequestPaginateTypeDef = {  # (1)
    "sortFields": ...,
}

parent.paginate(**kwargs)
  1. See ListNetworksRequestPaginateTypeDef

ListSecurityGroupUsersPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_security_group_users"). boto3 documentation

# ListSecurityGroupUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListSecurityGroupUsersPaginator

def get_list_security_group_users_paginator() -> ListSecurityGroupUsersPaginator:
    return Session().client("wickr").get_paginator("list_security_group_users")
# ListSecurityGroupUsersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListSecurityGroupUsersPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListSecurityGroupUsersPaginator = client.get_paginator("list_security_group_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListSecurityGroupUsersPaginator
  3. item: PageIterator[ListSecurityGroupUsersResponseTypeDef]

paginate#

Type annotations and code completion for ListSecurityGroupUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    groupId: str,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListSecurityGroupUsersResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListSecurityGroupUsersResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListSecurityGroupUsersRequestPaginateTypeDef = {  # (1)
    "networkId": ...,
    "groupId": ...,
}

parent.paginate(**kwargs)
  1. See ListSecurityGroupUsersRequestPaginateTypeDef

ListSecurityGroupsPaginator#

Type annotations and code completion for boto3.client("wickr").get_paginator("list_security_groups"). boto3 documentation

# ListSecurityGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListSecurityGroupsPaginator

def get_list_security_groups_paginator() -> ListSecurityGroupsPaginator:
    return Session().client("wickr").get_paginator("list_security_groups")
# ListSecurityGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListSecurityGroupsPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListSecurityGroupsPaginator = client.get_paginator("list_security_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListSecurityGroupsPaginator
  3. item: PageIterator[ListSecurityGroupsResponseTypeDef]

paginate#

Type annotations and code completion for ListSecurityGroupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListSecurityGroupsResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListSecurityGroupsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListSecurityGroupsRequestPaginateTypeDef = {  # (1)
    "networkId": ...,
}

parent.paginate(**kwargs)
  1. See ListSecurityGroupsRequestPaginateTypeDef

ListUsersPaginator#

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

# ListUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListUsersPaginator

def get_list_users_paginator() -> ListUsersPaginator:
    return Session().client("wickr").get_paginator("list_users")
# ListUsersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_wickr.paginator import ListUsersPaginator

session = Session()

client = Session().client("wickr")  # (1)
paginator: ListUsersPaginator = client.get_paginator("list_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WickrAdminAPIClient
  2. paginator: ListUsersPaginator
  3. item: PageIterator[ListUsersResponseTypeDef]

paginate#

Type annotations and code completion for ListUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    networkId: str,
    sortFields: str = ...,
    sortDirection: SortDirectionType = ...,  # (1)
    firstName: str = ...,
    lastName: str = ...,
    username: str = ...,
    status: int = ...,
    groupId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> botocore.paginate.PageIterator[ListUsersResponseTypeDef]:  # (3)
    ...
  1. See SortDirectionType
  2. See PaginatorConfigTypeDef
  3. See PageIterator[ListUsersResponseTypeDef]
# paginate method usage example with argument unpacking

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

parent.paginate(**kwargs)
  1. See ListUsersRequestPaginateTypeDef