WorkDocs module
Index > WorkDocs
Auto-generated documentation for WorkDocs type annotations stubs module types-aiobotocore-workdocs.
How to install
From PyPI with pip
Install types-aioboto3
for WorkDocs
service.
# install with aioboto3 type annotations
python -m pip install 'types-aioboto3[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-aioboto3-lite[workdocs]'
# standalone installation
python -m pip install types-aiobotocore-workdocs
How to uninstall
Usage
Code samples can be found in Examples.
WorkDocsClient
Type annotations and code completion for session.client("workdocs")
as WorkDocsClient
boto3 documentation
Usage example
from aioboto3.session import Session
from types_aiobotocore_workdocs.client import WorkDocsClient
session = Session()
async with session.client("workdocs") as client:
client: WorkDocsClient
Paginators
Type annotations and code completion for
paginators
from session.client("workdocs").get_paginator("...")
.
Usage example
from types_aiobotocore_workdocs.paginator import DescribeActivitiesPaginator
def get_describe_activities_paginator() -> DescribeActivitiesPaginator:
return client.get_paginator("describe_activities"))
- DescribeActivitiesPaginator
- DescribeCommentsPaginator
- DescribeDocumentVersionsPaginator
- DescribeFolderContentsPaginator
- DescribeGroupsPaginator
- DescribeNotificationSubscriptionsPaginator
- DescribeResourcePermissionsPaginator
- DescribeRootFoldersPaginator
- DescribeUsersPaginator
Literals
Type annotations for literals used in methods and schema.
Usage example
from types_aiobotocore_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 types_aiobotocore_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
- 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
- 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