Skip to content

Paginators#

Index > WorkMail > Paginators

Auto-generated documentation for WorkMail type annotations stubs module types-aiobotocore-workmail.

ListAliasesPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_aliases"). boto3 documentation

# ListAliasesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListAliasesPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListAliasesPaginator = client.get_paginator("list_aliases")  # (2)
    async for item in paginator.paginate(...):
        item: ListAliasesResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListAliasesPaginator
  3. item: AioPageIterator[ListAliasesResponseTypeDef]

paginate#

Type annotations and code completion for ListAliasesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListAliasesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListAliasesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListAliasesRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

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

ListAvailabilityConfigurationsPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_availability_configurations"). boto3 documentation

# ListAvailabilityConfigurationsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListAvailabilityConfigurationsPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListAvailabilityConfigurationsPaginator = client.get_paginator("list_availability_configurations")  # (2)
    async for item in paginator.paginate(...):
        item: ListAvailabilityConfigurationsResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListAvailabilityConfigurationsPaginator
  3. item: AioPageIterator[ListAvailabilityConfigurationsResponseTypeDef]

paginate#

Type annotations and code completion for ListAvailabilityConfigurationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListAvailabilityConfigurationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListAvailabilityConfigurationsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListAvailabilityConfigurationsRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

ListGroupMembersPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_group_members"). boto3 documentation

# ListGroupMembersPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListGroupMembersPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListGroupMembersPaginator = client.get_paginator("list_group_members")  # (2)
    async for item in paginator.paginate(...):
        item: ListGroupMembersResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListGroupMembersPaginator
  3. item: AioPageIterator[ListGroupMembersResponseTypeDef]

paginate#

Type annotations and code completion for ListGroupMembersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListGroupMembersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListGroupMembersResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListGroupMembersRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
    "GroupId": ...,
}

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

ListGroupsPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_groups"). boto3 documentation

# ListGroupsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListGroupsPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListGroupsPaginator = client.get_paginator("list_groups")  # (2)
    async for item in paginator.paginate(...):
        item: ListGroupsResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListGroupsPaginator
  3. item: AioPageIterator[ListGroupsResponseTypeDef]

paginate#

Type annotations and code completion for ListGroupsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    Filters: ListGroupsFiltersTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> aiobotocore.paginate.AioPageIterator[ListGroupsResponseTypeDef]:  # (3)
    ...
  1. See ListGroupsFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See AioPageIterator[ListGroupsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListGroupsRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

ListMailboxPermissionsPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_mailbox_permissions"). boto3 documentation

# ListMailboxPermissionsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListMailboxPermissionsPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListMailboxPermissionsPaginator = client.get_paginator("list_mailbox_permissions")  # (2)
    async for item in paginator.paginate(...):
        item: ListMailboxPermissionsResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListMailboxPermissionsPaginator
  3. item: AioPageIterator[ListMailboxPermissionsResponseTypeDef]

paginate#

Type annotations and code completion for ListMailboxPermissionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListMailboxPermissionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListMailboxPermissionsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListMailboxPermissionsRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
    "EntityId": ...,
}

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

ListOrganizationsPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_organizations"). boto3 documentation

# ListOrganizationsPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListOrganizationsPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListOrganizationsPaginator = client.get_paginator("list_organizations")  # (2)
    async for item in paginator.paginate(...):
        item: ListOrganizationsResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListOrganizationsPaginator
  3. item: AioPageIterator[ListOrganizationsResponseTypeDef]

paginate#

Type annotations and code completion for ListOrganizationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListOrganizationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListOrganizationsResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListOrganizationsRequestPaginateTypeDef = {  # (1)
    "PaginationConfig": ...,
}

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

ListPersonalAccessTokensPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_personal_access_tokens"). boto3 documentation

# ListPersonalAccessTokensPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListPersonalAccessTokensPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListPersonalAccessTokensPaginator = client.get_paginator("list_personal_access_tokens")  # (2)
    async for item in paginator.paginate(...):
        item: ListPersonalAccessTokensResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListPersonalAccessTokensPaginator
  3. item: AioPageIterator[ListPersonalAccessTokensResponseTypeDef]

paginate#

Type annotations and code completion for ListPersonalAccessTokensPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    UserId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListPersonalAccessTokensResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListPersonalAccessTokensResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListPersonalAccessTokensRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

ListResourceDelegatesPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_resource_delegates"). boto3 documentation

# ListResourceDelegatesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListResourceDelegatesPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListResourceDelegatesPaginator = client.get_paginator("list_resource_delegates")  # (2)
    async for item in paginator.paginate(...):
        item: ListResourceDelegatesResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListResourceDelegatesPaginator
  3. item: AioPageIterator[ListResourceDelegatesResponseTypeDef]

paginate#

Type annotations and code completion for ListResourceDelegatesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> aiobotocore.paginate.AioPageIterator[ListResourceDelegatesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See AioPageIterator[ListResourceDelegatesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListResourceDelegatesRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
    "ResourceId": ...,
}

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

ListResourcesPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_resources"). boto3 documentation

# ListResourcesPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListResourcesPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListResourcesPaginator = client.get_paginator("list_resources")  # (2)
    async for item in paginator.paginate(...):
        item: ListResourcesResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListResourcesPaginator
  3. item: AioPageIterator[ListResourcesResponseTypeDef]

paginate#

Type annotations and code completion for ListResourcesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    Filters: ListResourcesFiltersTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> aiobotocore.paginate.AioPageIterator[ListResourcesResponseTypeDef]:  # (3)
    ...
  1. See ListResourcesFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See AioPageIterator[ListResourcesResponseTypeDef]
# paginate method usage example with argument unpacking

kwargs: ListResourcesRequestPaginateTypeDef = {  # (1)
    "OrganizationId": ...,
}

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

ListUsersPaginator#

Type annotations and code completion for session.create_client("workmail").get_paginator("list_users"). boto3 documentation

# ListUsersPaginator usage example

from aiobotocore.session import get_session

from types_aiobotocore_workmail.paginator import ListUsersPaginator

session = get_session()
async with session.create_client("workmail") as client:  # (1)
    paginator: ListUsersPaginator = client.get_paginator("list_users")  # (2)
    async for item in paginator.paginate(...):
        item: ListUsersResponseTypeDef
        print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListUsersPaginator
  3. item: AioPageIterator[ListUsersResponseTypeDef]

paginate#

Type annotations and code completion for ListUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    Filters: ListUsersFiltersTypeDef = ...,  # (1)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> aiobotocore.paginate.AioPageIterator[ListUsersResponseTypeDef]:  # (3)
    ...
  1. See ListUsersFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See AioPageIterator[ListUsersResponseTypeDef]
# paginate method usage example with argument unpacking

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

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