WorkDocs module#
Index > WorkDocs
Auto-generated documentation for WorkDocs type annotations stubs module types-boto3-workdocs.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
WorkDocs
service. - Use provided commands to install generated packages.
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and WorkDocs
.
From PyPI with pip#
Install types-boto3
for WorkDocs
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[workdocs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[workdocs]'
# standalone installation
python -m pip install types-boto3-workdocs
How to uninstall#
python -m pip uninstall -y types-boto3-workdocs
Usage#
Code samples can be found in Examples.
WorkDocsClient#
Type annotations and code completion for boto3.client("workdocs")
as WorkDocsClient
boto3 documentation
# WorkDocsClient usage example
from boto3.session import Session
from types_boto3_workdocs.client import WorkDocsClient
def get_client() -> WorkDocsClient:
return Session().client("workdocs")
Paginators#
Type annotations and code completion for paginators
from boto3.client("workdocs").get_paginator("...")
.
# DescribeActivitiesPaginator usage example
from boto3.session import Session
from types_boto3_workdocs.paginator import DescribeActivitiesPaginator
def get_describe_activities_paginator() -> DescribeActivitiesPaginator:
return Session().client("workdocs").get_paginator("describe_activities"))
- DescribeActivitiesPaginator
- DescribeCommentsPaginator
- DescribeDocumentVersionsPaginator
- DescribeFolderContentsPaginator
- DescribeGroupsPaginator
- DescribeNotificationSubscriptionsPaginator
- DescribeResourcePermissionsPaginator
- DescribeRootFoldersPaginator
- DescribeUsersPaginator
- SearchResourcesPaginator
Literals#
Type annotations for literals used in methods and schema.
# ActivityTypeType usage example
from types_boto3_workdocs.literals import ActivityTypeType
def get_value() -> ActivityTypeType:
return "DOCUMENT_ANNOTATION_ADDED"
- ActivityTypeType
- AdditionalResponseFieldTypeType
- BooleanEnumTypeType
- CommentStatusTypeType
- CommentVisibilityTypeType
- ContentCategoryTypeType
- DescribeActivitiesPaginatorName
- DescribeCommentsPaginatorName
- DescribeDocumentVersionsPaginatorName
- DescribeFolderContentsPaginatorName
- DescribeGroupsPaginatorName
- DescribeNotificationSubscriptionsPaginatorName
- DescribeResourcePermissionsPaginatorName
- DescribeRootFoldersPaginatorName
- DescribeUsersPaginatorName
- DocumentSourceTypeType
- DocumentStatusTypeType
- DocumentThumbnailTypeType
- DocumentVersionStatusType
- FolderContentTypeType
- LanguageCodeTypeType
- LocaleTypeType
- OrderByFieldTypeType
- OrderTypeType
- PrincipalRoleTypeType
- PrincipalTypeType
- ResourceCollectionTypeType
- ResourceSortTypeType
- ResourceStateTypeType
- ResourceTypeType
- ResponseItemTypeType
- RolePermissionTypeType
- RoleTypeType
- SearchCollectionTypeType
- SearchQueryScopeTypeType
- SearchResourceTypeType
- SearchResourcesPaginatorName
- ShareStatusTypeType
- SortOrderType
- StorageTypeType
- SubscriptionProtocolTypeType
- SubscriptionTypeType
- UserFilterTypeType
- UserSortTypeType
- UserStatusTypeType
- UserTypeType
- WorkDocsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AbortDocumentVersionUploadRequestTypeDef
- ActivateUserRequestTypeDef
- ResponseMetadataTypeDef
- UserMetadataTypeDef
- NotificationOptionsTypeDef
- SharePrincipalTypeDef
- ShareResultTypeDef
- CreateCommentRequestTypeDef
- CreateCustomMetadataRequestTypeDef
- CreateFolderRequestTypeDef
- FolderMetadataTypeDef
- CreateLabelsRequestTypeDef
- CreateNotificationSubscriptionRequestTypeDef
- SubscriptionTypeDef
- StorageRuleTypeTypeDef
- TimestampTypeDef
- DeactivateUserRequestTypeDef
- DeleteCommentRequestTypeDef
- DeleteCustomMetadataRequestTypeDef
- DeleteDocumentRequestTypeDef
- DeleteDocumentVersionRequestTypeDef
- DeleteFolderContentsRequestTypeDef
- DeleteFolderRequestTypeDef
- DeleteLabelsRequestTypeDef
- DeleteNotificationSubscriptionRequestTypeDef
- DeleteUserRequestTypeDef
- PaginatorConfigTypeDef
- DescribeCommentsRequestTypeDef
- DescribeDocumentVersionsRequestTypeDef
- DocumentVersionMetadataTypeDef
- DescribeFolderContentsRequestTypeDef
- DescribeGroupsRequestTypeDef
- GroupMetadataTypeDef
- DescribeNotificationSubscriptionsRequestTypeDef
- DescribeResourcePermissionsRequestTypeDef
- DescribeRootFoldersRequestTypeDef
- DescribeUsersRequestTypeDef
- LongRangeTypeTypeDef
- SearchPrincipalTypeTypeDef
- GetCurrentUserRequestTypeDef
- GetDocumentPathRequestTypeDef
- GetDocumentRequestTypeDef
- GetDocumentVersionRequestTypeDef
- GetFolderPathRequestTypeDef
- GetFolderRequestTypeDef
- GetResourcesRequestTypeDef
- UploadMetadataTypeDef
- PermissionInfoTypeDef
- RemoveAllResourcePermissionsRequestTypeDef
- RemoveResourcePermissionRequestTypeDef
- ResourcePathComponentTypeDef
- RestoreDocumentVersionsRequestTypeDef
- SearchSortResultTypeDef
- UpdateDocumentRequestTypeDef
- UpdateDocumentVersionRequestTypeDef
- UpdateFolderRequestTypeDef
- EmptyResponseMetadataTypeDef
- ResourceMetadataTypeDef
- AddResourcePermissionsRequestTypeDef
- AddResourcePermissionsResponseTypeDef
- CreateFolderResponseTypeDef
- DescribeRootFoldersResponseTypeDef
- GetFolderResponseTypeDef
- CreateNotificationSubscriptionResponseTypeDef
- DescribeNotificationSubscriptionsResponseTypeDef
- CreateUserRequestTypeDef
- UpdateUserRequestTypeDef
- UserStorageMetadataTypeDef
- DateRangeTypeTypeDef
- DescribeActivitiesRequestTypeDef
- InitiateDocumentVersionUploadRequestTypeDef
- DescribeActivitiesRequestPaginateTypeDef
- DescribeCommentsRequestPaginateTypeDef
- DescribeDocumentVersionsRequestPaginateTypeDef
- DescribeFolderContentsRequestPaginateTypeDef
- DescribeGroupsRequestPaginateTypeDef
- DescribeNotificationSubscriptionsRequestPaginateTypeDef
- DescribeResourcePermissionsRequestPaginateTypeDef
- DescribeRootFoldersRequestPaginateTypeDef
- DescribeUsersRequestPaginateTypeDef
- DescribeDocumentVersionsResponseTypeDef
- DocumentMetadataTypeDef
- GetDocumentVersionResponseTypeDef
- DescribeGroupsResponseTypeDef
- ParticipantsTypeDef
- PrincipalTypeDef
- ResourcePathTypeDef
- UserTypeDef
- FiltersTypeDef
- DescribeFolderContentsResponseTypeDef
- GetDocumentResponseTypeDef
- GetResourcesResponseTypeDef
- InitiateDocumentVersionUploadResponseTypeDef
- DescribeResourcePermissionsResponseTypeDef
- GetDocumentPathResponseTypeDef
- GetFolderPathResponseTypeDef
- ActivateUserResponseTypeDef
- CommentMetadataTypeDef
- CommentTypeDef
- CreateUserResponseTypeDef
- DescribeUsersResponseTypeDef
- GetCurrentUserResponseTypeDef
- UpdateUserResponseTypeDef
- SearchResourcesRequestPaginateTypeDef
- SearchResourcesRequestTypeDef
- ActivityTypeDef
- ResponseItemTypeDef
- CreateCommentResponseTypeDef
- DescribeCommentsResponseTypeDef
- DescribeActivitiesResponseTypeDef
- SearchResourcesResponseTypeDef