Skip to content

Paginators#

Index > WorkDocs > Paginators

Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.

DescribeActivitiesPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_activities"). boto3 documentation

# DescribeActivitiesPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeActivitiesPaginator

def get_describe_activities_paginator() -> DescribeActivitiesPaginator:
    return Session().client("workdocs").get_paginator("describe_activities")
# DescribeActivitiesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeActivitiesPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeActivitiesPaginator = client.get_paginator("describe_activities")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeActivitiesPaginator
  3. item: DescribeActivitiesResponseTypeDef

paginate#

Type annotations and code completion for DescribeActivitiesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    AuthenticationToken: str = ...,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    OrganizationId: str = ...,
    ActivityTypes: str = ...,
    ResourceId: str = ...,
    UserId: str = ...,
    IncludeIndirectActivities: bool = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeActivitiesResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeActivitiesResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

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

DescribeCommentsPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_comments"). boto3 documentation

# DescribeCommentsPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeCommentsPaginator

def get_describe_comments_paginator() -> DescribeCommentsPaginator:
    return Session().client("workdocs").get_paginator("describe_comments")
# DescribeCommentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeCommentsPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeCommentsPaginator = client.get_paginator("describe_comments")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeCommentsPaginator
  3. item: DescribeCommentsResponseTypeDef

paginate#

Type annotations and code completion for DescribeCommentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeCommentsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeCommentsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeCommentsRequestDescribeCommentsPaginateTypeDef = {  # (1)
    "DocumentId": ...,
    "VersionId": ...,
}

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

DescribeDocumentVersionsPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_document_versions"). boto3 documentation

# DescribeDocumentVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeDocumentVersionsPaginator

def get_describe_document_versions_paginator() -> DescribeDocumentVersionsPaginator:
    return Session().client("workdocs").get_paginator("describe_document_versions")
# DescribeDocumentVersionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeDocumentVersionsPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeDocumentVersionsPaginator = client.get_paginator("describe_document_versions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeDocumentVersionsPaginator
  3. item: DescribeDocumentVersionsResponseTypeDef

paginate#

Type annotations and code completion for DescribeDocumentVersionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DocumentId: str,
    AuthenticationToken: str = ...,
    Include: str = ...,
    Fields: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeDocumentVersionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeDocumentVersionsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef = {  # (1)
    "DocumentId": ...,
}

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

DescribeFolderContentsPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_folder_contents"). boto3 documentation

# DescribeFolderContentsPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeFolderContentsPaginator

def get_describe_folder_contents_paginator() -> DescribeFolderContentsPaginator:
    return Session().client("workdocs").get_paginator("describe_folder_contents")
# DescribeFolderContentsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeFolderContentsPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeFolderContentsPaginator = client.get_paginator("describe_folder_contents")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeFolderContentsPaginator
  3. item: DescribeFolderContentsResponseTypeDef

paginate#

Type annotations and code completion for DescribeFolderContentsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    FolderId: str,
    AuthenticationToken: str = ...,
    Sort: ResourceSortTypeType = ...,  # (1)
    Order: OrderTypeType = ...,  # (2)
    Type: FolderContentTypeType = ...,  # (3)
    Include: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> _PageIterator[DescribeFolderContentsResponseTypeDef]:  # (5)
    ...
  1. See ResourceSortTypeType
  2. See OrderTypeType
  3. See FolderContentTypeType
  4. See PaginatorConfigTypeDef
  5. See DescribeFolderContentsResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef = {  # (1)
    "FolderId": ...,
}

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

DescribeGroupsPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_groups"). boto3 documentation

# DescribeGroupsPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeGroupsPaginator

def get_describe_groups_paginator() -> DescribeGroupsPaginator:
    return Session().client("workdocs").get_paginator("describe_groups")
# DescribeGroupsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeGroupsPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeGroupsPaginator = client.get_paginator("describe_groups")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeGroupsPaginator
  3. item: DescribeGroupsResponseTypeDef

paginate#

Type annotations and code completion for DescribeGroupsPaginator.paginate method.

# paginate method definition

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

kwargs: DescribeGroupsRequestDescribeGroupsPaginateTypeDef = {  # (1)
    "SearchQuery": ...,
}

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

DescribeNotificationSubscriptionsPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_notification_subscriptions"). boto3 documentation

# DescribeNotificationSubscriptionsPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeNotificationSubscriptionsPaginator

def get_describe_notification_subscriptions_paginator() -> DescribeNotificationSubscriptionsPaginator:
    return Session().client("workdocs").get_paginator("describe_notification_subscriptions")
# DescribeNotificationSubscriptionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeNotificationSubscriptionsPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeNotificationSubscriptionsPaginator = client.get_paginator("describe_notification_subscriptions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeNotificationSubscriptionsPaginator
  3. item: DescribeNotificationSubscriptionsResponseTypeDef

paginate#

Type annotations and code completion for DescribeNotificationSubscriptionsPaginator.paginate method.

# paginate method definition

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

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

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

DescribeResourcePermissionsPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_resource_permissions"). boto3 documentation

# DescribeResourcePermissionsPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeResourcePermissionsPaginator

def get_describe_resource_permissions_paginator() -> DescribeResourcePermissionsPaginator:
    return Session().client("workdocs").get_paginator("describe_resource_permissions")
# DescribeResourcePermissionsPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeResourcePermissionsPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeResourcePermissionsPaginator = client.get_paginator("describe_resource_permissions")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeResourcePermissionsPaginator
  3. item: DescribeResourcePermissionsResponseTypeDef

paginate#

Type annotations and code completion for DescribeResourcePermissionsPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    ResourceId: str,
    AuthenticationToken: str = ...,
    PrincipalId: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeResourcePermissionsResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeResourcePermissionsResponseTypeDef 
# paginate method usage example with argument unpacking

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

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

DescribeRootFoldersPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_root_folders"). boto3 documentation

# DescribeRootFoldersPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeRootFoldersPaginator

def get_describe_root_folders_paginator() -> DescribeRootFoldersPaginator:
    return Session().client("workdocs").get_paginator("describe_root_folders")
# DescribeRootFoldersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeRootFoldersPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeRootFoldersPaginator = client.get_paginator("describe_root_folders")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeRootFoldersPaginator
  3. item: DescribeRootFoldersResponseTypeDef

paginate#

Type annotations and code completion for DescribeRootFoldersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    AuthenticationToken: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (1)
) -> _PageIterator[DescribeRootFoldersResponseTypeDef]:  # (2)
    ...
  1. See PaginatorConfigTypeDef
  2. See DescribeRootFoldersResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

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

DescribeUsersPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("describe_users"). boto3 documentation

# DescribeUsersPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeUsersPaginator

def get_describe_users_paginator() -> DescribeUsersPaginator:
    return Session().client("workdocs").get_paginator("describe_users")
# DescribeUsersPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import DescribeUsersPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: DescribeUsersPaginator = client.get_paginator("describe_users")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: DescribeUsersPaginator
  3. item: DescribeUsersResponseTypeDef

paginate#

Type annotations and code completion for DescribeUsersPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    AuthenticationToken: str = ...,
    OrganizationId: str = ...,
    UserIds: str = ...,
    Query: str = ...,
    Include: UserFilterTypeType = ...,  # (1)
    Order: OrderTypeType = ...,  # (2)
    Sort: UserSortTypeType = ...,  # (3)
    Fields: str = ...,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (4)
) -> _PageIterator[DescribeUsersResponseTypeDef]:  # (5)
    ...
  1. See UserFilterTypeType
  2. See OrderTypeType
  3. See UserSortTypeType
  4. See PaginatorConfigTypeDef
  5. See DescribeUsersResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: DescribeUsersRequestDescribeUsersPaginateTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

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

SearchResourcesPaginator#

Type annotations and code completion for boto3.client("workdocs").get_paginator("search_resources"). boto3 documentation

# SearchResourcesPaginator usage example

from boto3.session import Session

from mypy_boto3_workdocs.paginator import SearchResourcesPaginator

def get_search_resources_paginator() -> SearchResourcesPaginator:
    return Session().client("workdocs").get_paginator("search_resources")
# SearchResourcesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_workdocs.paginator import SearchResourcesPaginator

session = Session()

client = Session().client("workdocs")  # (1)
paginator: SearchResourcesPaginator = client.get_paginator("search_resources")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: WorkDocsClient
  2. paginator: SearchResourcesPaginator
  3. item: SearchResourcesResponseTypeDef

paginate#

Type annotations and code completion for SearchResourcesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    AuthenticationToken: str = ...,
    QueryText: str = ...,
    QueryScopes: Sequence[SearchQueryScopeTypeType] = ...,  # (1)
    OrganizationId: str = ...,
    AdditionalResponseFields: Sequence[AdditionalResponseFieldTypeType] = ...,  # (2)
    Filters: FiltersTypeDef = ...,  # (3)
    OrderBy: Sequence[SearchSortResultTypeDef] = ...,  # (4)
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (5)
) -> _PageIterator[SearchResourcesResponseTypeDef]:  # (6)
    ...
  1. See SearchQueryScopeTypeType
  2. See AdditionalResponseFieldTypeType
  3. See FiltersTypeDef
  4. See SearchSortResultTypeDef
  5. See PaginatorConfigTypeDef
  6. See SearchResourcesResponseTypeDef 
# paginate method usage example with argument unpacking

kwargs: SearchResourcesRequestSearchResourcesPaginateTypeDef = {  # (1)
    "AuthenticationToken": ...,
}

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