WorkDocs module
Index > WorkDocs
Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.
How to install
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 boto3-stubs
for WorkDocs
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[workdocs]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[workdocs]'
# standalone installation
python -m pip install mypy-boto3-workdocs
How to uninstall
Usage
Code samples can be found in Examples.
WorkDocsClient
Type annotations and code completion for boto3.client("workdocs")
as WorkDocsClient
boto3 documentation
Usage example
from boto3.session import Session
from mypy_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("...")
.
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
- DescribeCommentsPaginator
- DescribeDocumentVersionsPaginator
- DescribeFolderContentsPaginator
- DescribeGroupsPaginator
- DescribeNotificationSubscriptionsPaginator
- DescribeResourcePermissionsPaginator
- DescribeRootFoldersPaginator
- DescribeUsersPaginator
Literals
Type annotations for literals used in methods and schemas.
Usage example
from mypy_boto3_workdocs.literals import ActivityTypeType
def get_value() -> ActivityTypeType:
return "DOCUMENT_ANNOTATION_ADDED"
- ActivityTypeType
- BooleanEnumTypeType
- CommentStatusTypeType
- CommentVisibilityTypeType
- DescribeActivitiesPaginatorName
- DescribeCommentsPaginatorName
- DescribeDocumentVersionsPaginatorName
- DescribeFolderContentsPaginatorName
- DescribeGroupsPaginatorName
- DescribeNotificationSubscriptionsPaginatorName
- DescribeResourcePermissionsPaginatorName
- DescribeRootFoldersPaginatorName
- DescribeUsersPaginatorName
- DocumentSourceTypeType
- DocumentStatusTypeType
- DocumentThumbnailTypeType
- DocumentVersionStatusType
- FolderContentTypeType
- LocaleTypeType
- OrderTypeType
- PrincipalTypeType
- ResourceCollectionTypeType
- ResourceSortTypeType
- ResourceStateTypeType
- ResourceTypeType
- RolePermissionTypeType
- RoleTypeType
- ShareStatusTypeType
- StorageTypeType
- SubscriptionProtocolTypeType
- SubscriptionTypeType
- UserFilterTypeType
- UserSortTypeType
- UserStatusTypeType
- UserTypeType
- WorkDocsServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries
Type annotations for typed dictionaries used in methods and schema.
Usage example
from mypy_boto3_workdocs.type_defs import AbortDocumentVersionUploadRequestRequestTypeDef
def get_value() -> AbortDocumentVersionUploadRequestRequestTypeDef:
return {
"DocumentId": ...,
"VersionId": ...,
}
- AbortDocumentVersionUploadRequestRequestTypeDef
- ActivateUserRequestRequestTypeDef
- ResponseMetadataTypeDef
- UserMetadataTypeDef
- NotificationOptionsTypeDef
- SharePrincipalTypeDef
- ShareResultTypeDef
- CreateCommentRequestRequestTypeDef
- CreateCustomMetadataRequestRequestTypeDef
- CreateFolderRequestRequestTypeDef
- FolderMetadataTypeDef
- CreateLabelsRequestRequestTypeDef
- CreateNotificationSubscriptionRequestRequestTypeDef
- SubscriptionTypeDef
- StorageRuleTypeTypeDef
- DeactivateUserRequestRequestTypeDef
- DeleteCommentRequestRequestTypeDef
- DeleteCustomMetadataRequestRequestTypeDef
- DeleteDocumentRequestRequestTypeDef
- DeleteDocumentVersionRequestRequestTypeDef
- DeleteFolderContentsRequestRequestTypeDef
- DeleteFolderRequestRequestTypeDef
- DeleteLabelsRequestRequestTypeDef
- DeleteNotificationSubscriptionRequestRequestTypeDef
- DeleteUserRequestRequestTypeDef
- PaginatorConfigTypeDef
- DescribeActivitiesRequestRequestTypeDef
- DescribeCommentsRequestRequestTypeDef
- DescribeDocumentVersionsRequestRequestTypeDef
- DocumentVersionMetadataTypeDef
- DescribeFolderContentsRequestRequestTypeDef
- DescribeGroupsRequestRequestTypeDef
- GroupMetadataTypeDef
- DescribeNotificationSubscriptionsRequestRequestTypeDef
- DescribeResourcePermissionsRequestRequestTypeDef
- DescribeRootFoldersRequestRequestTypeDef
- DescribeUsersRequestRequestTypeDef
- GetCurrentUserRequestRequestTypeDef
- GetDocumentPathRequestRequestTypeDef
- GetDocumentRequestRequestTypeDef
- GetDocumentVersionRequestRequestTypeDef
- GetFolderPathRequestRequestTypeDef
- GetFolderRequestRequestTypeDef
- GetResourcesRequestRequestTypeDef
- InitiateDocumentVersionUploadRequestRequestTypeDef
- UploadMetadataTypeDef
- PermissionInfoTypeDef
- RemoveAllResourcePermissionsRequestRequestTypeDef
- RemoveResourcePermissionRequestRequestTypeDef
- ResourcePathComponentTypeDef
- RestoreDocumentVersionsRequestRequestTypeDef
- UpdateDocumentRequestRequestTypeDef
- UpdateDocumentVersionRequestRequestTypeDef
- UpdateFolderRequestRequestTypeDef
- EmptyResponseMetadataTypeDef
- ResourceMetadataTypeDef
- AddResourcePermissionsRequestRequestTypeDef
- AddResourcePermissionsResponseTypeDef
- CreateFolderResponseTypeDef
- DescribeRootFoldersResponseTypeDef
- GetFolderResponseTypeDef
- CreateNotificationSubscriptionResponseTypeDef
- DescribeNotificationSubscriptionsResponseTypeDef
- CreateUserRequestRequestTypeDef
- UpdateUserRequestRequestTypeDef
- UserStorageMetadataTypeDef
- DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef
- DescribeCommentsRequestDescribeCommentsPaginateTypeDef
- DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef
- DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef
- DescribeGroupsRequestDescribeGroupsPaginateTypeDef
- DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef
- DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef
- DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef
- DescribeUsersRequestDescribeUsersPaginateTypeDef
- DescribeDocumentVersionsResponseTypeDef
- DocumentMetadataTypeDef
- GetDocumentVersionResponseTypeDef
- DescribeGroupsResponseTypeDef
- ParticipantsTypeDef
- PrincipalTypeDef
- ResourcePathTypeDef
- UserTypeDef
- DescribeFolderContentsResponseTypeDef
- GetDocumentResponseTypeDef
- GetResourcesResponseTypeDef
- InitiateDocumentVersionUploadResponseTypeDef
- DescribeResourcePermissionsResponseTypeDef
- GetDocumentPathResponseTypeDef
- GetFolderPathResponseTypeDef
- ActivateUserResponseTypeDef
- CommentMetadataTypeDef
- CommentTypeDef
- CreateUserResponseTypeDef
- DescribeUsersResponseTypeDef
- GetCurrentUserResponseTypeDef
- UpdateUserResponseTypeDef
- ActivityTypeDef
- CreateCommentResponseTypeDef
- DescribeCommentsResponseTypeDef
- DescribeActivitiesResponseTypeDef