Skip to content

Paginators#

Index > WorkMail > Paginators

Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.

ListAliasesPaginator#

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

# ListAliasesPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListAliasesPaginator

def get_list_aliases_paginator() -> ListAliasesPaginator:
    return Session().client("workmail").get_paginator("list_aliases")
# ListAliasesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListAliasesPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListAliasesPaginator = client.get_paginator("list_aliases")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListAliasesPaginator
  3. item: ListAliasesResponseTypeDef

paginate#

Type annotations and code completion for ListAliasesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListAliasesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_availability_configurations"). boto3 documentation

# ListAvailabilityConfigurationsPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListAvailabilityConfigurationsPaginator

def get_list_availability_configurations_paginator() -> ListAvailabilityConfigurationsPaginator:
    return Session().client("workmail").get_paginator("list_availability_configurations")
# ListAvailabilityConfigurationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListAvailabilityConfigurationsPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListAvailabilityConfigurationsPaginator = client.get_paginator("list_availability_configurations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListAvailabilityConfigurationsPaginator
  3. item: ListAvailabilityConfigurationsResponseTypeDef

paginate#

Type annotations and code completion for ListAvailabilityConfigurationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListAvailabilityConfigurationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_group_members"). boto3 documentation

# ListGroupMembersPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListGroupMembersPaginator

def get_list_group_members_paginator() -> ListGroupMembersPaginator:
    return Session().client("workmail").get_paginator("list_group_members")
# ListGroupMembersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListGroupMembersPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListGroupMembersPaginator = client.get_paginator("list_group_members")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListGroupMembersPaginator
  3. item: ListGroupMembersResponseTypeDef

paginate#

Type annotations and code completion for ListGroupMembersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    GroupId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListGroupMembersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_groups"). boto3 documentation

# ListGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListGroupsPaginator

def get_list_groups_paginator() -> ListGroupsPaginator:
    return Session().client("workmail").get_paginator("list_groups")
# ListGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListGroupsPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListGroupsPaginator = client.get_paginator("list_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListGroupsPaginator
  3. item: 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)
) -> PageIterator[ListGroupsResponseTypeDef]:  # (3)
    ...
  1. See ListGroupsFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See 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 boto3.client("workmail").get_paginator("list_mailbox_permissions"). boto3 documentation

# ListMailboxPermissionsPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListMailboxPermissionsPaginator

def get_list_mailbox_permissions_paginator() -> ListMailboxPermissionsPaginator:
    return Session().client("workmail").get_paginator("list_mailbox_permissions")
# ListMailboxPermissionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListMailboxPermissionsPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListMailboxPermissionsPaginator = client.get_paginator("list_mailbox_permissions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListMailboxPermissionsPaginator
  3. item: ListMailboxPermissionsResponseTypeDef

paginate#

Type annotations and code completion for ListMailboxPermissionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    EntityId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListMailboxPermissionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_organizations"). boto3 documentation

# ListOrganizationsPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListOrganizationsPaginator

def get_list_organizations_paginator() -> ListOrganizationsPaginator:
    return Session().client("workmail").get_paginator("list_organizations")
# ListOrganizationsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListOrganizationsPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListOrganizationsPaginator = client.get_paginator("list_organizations")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListOrganizationsPaginator
  3. item: ListOrganizationsResponseTypeDef

paginate#

Type annotations and code completion for ListOrganizationsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListOrganizationsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_personal_access_tokens"). boto3 documentation

# ListPersonalAccessTokensPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListPersonalAccessTokensPaginator

def get_list_personal_access_tokens_paginator() -> ListPersonalAccessTokensPaginator:
    return Session().client("workmail").get_paginator("list_personal_access_tokens")
# ListPersonalAccessTokensPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListPersonalAccessTokensPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListPersonalAccessTokensPaginator = client.get_paginator("list_personal_access_tokens")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListPersonalAccessTokensPaginator
  3. item: ListPersonalAccessTokensResponseTypeDef

paginate#

Type annotations and code completion for ListPersonalAccessTokensPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    UserId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListPersonalAccessTokensResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_resource_delegates"). boto3 documentation

# ListResourceDelegatesPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListResourceDelegatesPaginator

def get_list_resource_delegates_paginator() -> ListResourceDelegatesPaginator:
    return Session().client("workmail").get_paginator("list_resource_delegates")
# ListResourceDelegatesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListResourceDelegatesPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListResourceDelegatesPaginator = client.get_paginator("list_resource_delegates")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListResourceDelegatesPaginator
  3. item: ListResourceDelegatesResponseTypeDef

paginate#

Type annotations and code completion for ListResourceDelegatesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    OrganizationId: str,
    ResourceId: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> PageIterator[ListResourceDelegatesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See 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 boto3.client("workmail").get_paginator("list_resources"). boto3 documentation

# ListResourcesPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListResourcesPaginator

def get_list_resources_paginator() -> ListResourcesPaginator:
    return Session().client("workmail").get_paginator("list_resources")
# ListResourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListResourcesPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListResourcesPaginator = client.get_paginator("list_resources")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListResourcesPaginator
  3. item: 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)
) -> PageIterator[ListResourcesResponseTypeDef]:  # (3)
    ...
  1. See ListResourcesFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See 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 boto3.client("workmail").get_paginator("list_users"). boto3 documentation

# ListUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListUsersPaginator

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

from boto3.session import Session

from mypy_boto3_workmail.paginator import ListUsersPaginator

session = Session()

client = Session().client("workmail")  # (1)
paginator: ListUsersPaginator = client.get_paginator("list_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkMailClient
  2. paginator: ListUsersPaginator
  3. item: 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)
) -> PageIterator[ListUsersResponseTypeDef]:  # (3)
    ...
  1. See ListUsersFiltersTypeDef
  2. See PaginatorConfigTypeDef
  3. See ListUsersResponseTypeDef 
# paginate method usage example with argument unpacking

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

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