Type definitions#
Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AbortDocumentVersionUploadRequestRequestTypeDef#
# AbortDocumentVersionUploadRequestRequestTypeDef definition
class AbortDocumentVersionUploadRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
ActivateUserRequestRequestTypeDef#
# ActivateUserRequestRequestTypeDef definition
class ActivateUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
UserMetadataTypeDef#
# UserMetadataTypeDef definition
class UserMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Username: NotRequired[str],
GivenName: NotRequired[str],
Surname: NotRequired[str],
EmailAddress: NotRequired[str],
NotificationOptionsTypeDef#
# NotificationOptionsTypeDef definition
class NotificationOptionsTypeDef(TypedDict):
SendEmail: NotRequired[bool],
EmailMessage: NotRequired[str],
SharePrincipalTypeDef#
# SharePrincipalTypeDef definition
class SharePrincipalTypeDef(TypedDict):
Id: str,
Type: PrincipalTypeType, # (1)
Role: RoleTypeType, # (2)
- See PrincipalTypeType
- See RoleTypeType
ShareResultTypeDef#
# ShareResultTypeDef definition
class ShareResultTypeDef(TypedDict):
PrincipalId: NotRequired[str],
InviteePrincipalId: NotRequired[str],
Role: NotRequired[RoleTypeType], # (1)
Status: NotRequired[ShareStatusTypeType], # (2)
ShareId: NotRequired[str],
StatusMessage: NotRequired[str],
- See RoleTypeType
- See ShareStatusTypeType
CreateCommentRequestRequestTypeDef#
# CreateCommentRequestRequestTypeDef definition
class CreateCommentRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
Text: str,
AuthenticationToken: NotRequired[str],
ParentId: NotRequired[str],
ThreadId: NotRequired[str],
Visibility: NotRequired[CommentVisibilityTypeType], # (1)
NotifyCollaborators: NotRequired[bool],
CreateCustomMetadataRequestRequestTypeDef#
# CreateCustomMetadataRequestRequestTypeDef definition
class CreateCustomMetadataRequestRequestTypeDef(TypedDict):
ResourceId: str,
CustomMetadata: Mapping[str, str],
AuthenticationToken: NotRequired[str],
VersionId: NotRequired[str],
CreateFolderRequestRequestTypeDef#
# CreateFolderRequestRequestTypeDef definition
class CreateFolderRequestRequestTypeDef(TypedDict):
ParentFolderId: str,
AuthenticationToken: NotRequired[str],
Name: NotRequired[str],
FolderMetadataTypeDef#
# FolderMetadataTypeDef definition
class FolderMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
CreatorId: NotRequired[str],
ParentFolderId: NotRequired[str],
CreatedTimestamp: NotRequired[datetime],
ModifiedTimestamp: NotRequired[datetime],
ResourceState: NotRequired[ResourceStateTypeType], # (1)
Signature: NotRequired[str],
Labels: NotRequired[List[str]],
Size: NotRequired[int],
LatestVersionSize: NotRequired[int],
CreateLabelsRequestRequestTypeDef#
# CreateLabelsRequestRequestTypeDef definition
class CreateLabelsRequestRequestTypeDef(TypedDict):
ResourceId: str,
Labels: Sequence[str],
AuthenticationToken: NotRequired[str],
CreateNotificationSubscriptionRequestRequestTypeDef#
# CreateNotificationSubscriptionRequestRequestTypeDef definition
class CreateNotificationSubscriptionRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Endpoint: str,
Protocol: SubscriptionProtocolTypeType, # (1)
SubscriptionType: SubscriptionTypeType, # (2)
SubscriptionTypeDef#
# SubscriptionTypeDef definition
class SubscriptionTypeDef(TypedDict):
SubscriptionId: NotRequired[str],
EndPoint: NotRequired[str],
Protocol: NotRequired[SubscriptionProtocolTypeType], # (1)
StorageRuleTypeTypeDef#
# StorageRuleTypeTypeDef definition
class StorageRuleTypeTypeDef(TypedDict):
StorageAllocatedInBytes: NotRequired[int],
StorageType: NotRequired[StorageTypeType], # (1)
- See StorageTypeType
DeactivateUserRequestRequestTypeDef#
# DeactivateUserRequestRequestTypeDef definition
class DeactivateUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
DeleteCommentRequestRequestTypeDef#
# DeleteCommentRequestRequestTypeDef definition
class DeleteCommentRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
CommentId: str,
AuthenticationToken: NotRequired[str],
DeleteCustomMetadataRequestRequestTypeDef#
# DeleteCustomMetadataRequestRequestTypeDef definition
class DeleteCustomMetadataRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
VersionId: NotRequired[str],
Keys: NotRequired[Sequence[str]],
DeleteAll: NotRequired[bool],
DeleteDocumentRequestRequestTypeDef#
# DeleteDocumentRequestRequestTypeDef definition
class DeleteDocumentRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
DeleteDocumentVersionRequestRequestTypeDef#
# DeleteDocumentVersionRequestRequestTypeDef definition
class DeleteDocumentVersionRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
DeletePriorVersions: bool,
AuthenticationToken: NotRequired[str],
DeleteFolderContentsRequestRequestTypeDef#
# DeleteFolderContentsRequestRequestTypeDef definition
class DeleteFolderContentsRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
DeleteFolderRequestRequestTypeDef#
# DeleteFolderRequestRequestTypeDef definition
class DeleteFolderRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
DeleteLabelsRequestRequestTypeDef#
# DeleteLabelsRequestRequestTypeDef definition
class DeleteLabelsRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
Labels: NotRequired[Sequence[str]],
DeleteAll: NotRequired[bool],
DeleteNotificationSubscriptionRequestRequestTypeDef#
# DeleteNotificationSubscriptionRequestRequestTypeDef definition
class DeleteNotificationSubscriptionRequestRequestTypeDef(TypedDict):
SubscriptionId: str,
OrganizationId: str,
DeleteUserRequestRequestTypeDef#
# DeleteUserRequestRequestTypeDef definition
class DeleteUserRequestRequestTypeDef(TypedDict):
UserId: str,
AuthenticationToken: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeCommentsRequestRequestTypeDef#
# DescribeCommentsRequestRequestTypeDef definition
class DescribeCommentsRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeDocumentVersionsRequestRequestTypeDef#
# DescribeDocumentVersionsRequestRequestTypeDef definition
class DescribeDocumentVersionsRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Marker: NotRequired[str],
Limit: NotRequired[int],
Include: NotRequired[str],
Fields: NotRequired[str],
DocumentVersionMetadataTypeDef#
# DocumentVersionMetadataTypeDef definition
class DocumentVersionMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
ContentType: NotRequired[str],
Size: NotRequired[int],
Signature: NotRequired[str],
Status: NotRequired[DocumentStatusTypeType], # (1)
CreatedTimestamp: NotRequired[datetime],
ModifiedTimestamp: NotRequired[datetime],
ContentCreatedTimestamp: NotRequired[datetime],
ContentModifiedTimestamp: NotRequired[datetime],
CreatorId: NotRequired[str],
Thumbnail: NotRequired[Dict[DocumentThumbnailTypeType, str]], # (2)
Source: NotRequired[Dict[DocumentSourceTypeType, str]], # (3)
DescribeFolderContentsRequestRequestTypeDef#
# DescribeFolderContentsRequestRequestTypeDef definition
class DescribeFolderContentsRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Sort: NotRequired[ResourceSortTypeType], # (1)
Order: NotRequired[OrderTypeType], # (2)
Limit: NotRequired[int],
Marker: NotRequired[str],
Type: NotRequired[FolderContentTypeType], # (3)
Include: NotRequired[str],
- See ResourceSortTypeType
- See OrderTypeType
- See FolderContentTypeType
DescribeGroupsRequestRequestTypeDef#
# DescribeGroupsRequestRequestTypeDef definition
class DescribeGroupsRequestRequestTypeDef(TypedDict):
SearchQuery: str,
AuthenticationToken: NotRequired[str],
OrganizationId: NotRequired[str],
Marker: NotRequired[str],
Limit: NotRequired[int],
GroupMetadataTypeDef#
# GroupMetadataTypeDef definition
class GroupMetadataTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
DescribeNotificationSubscriptionsRequestRequestTypeDef#
# DescribeNotificationSubscriptionsRequestRequestTypeDef definition
class DescribeNotificationSubscriptionsRequestRequestTypeDef(TypedDict):
OrganizationId: str,
Marker: NotRequired[str],
Limit: NotRequired[int],
DescribeResourcePermissionsRequestRequestTypeDef#
# DescribeResourcePermissionsRequestRequestTypeDef definition
class DescribeResourcePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
PrincipalId: NotRequired[str],
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeRootFoldersRequestRequestTypeDef#
# DescribeRootFoldersRequestRequestTypeDef definition
class DescribeRootFoldersRequestRequestTypeDef(TypedDict):
AuthenticationToken: str,
Limit: NotRequired[int],
Marker: NotRequired[str],
DescribeUsersRequestRequestTypeDef#
# DescribeUsersRequestRequestTypeDef definition
class DescribeUsersRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
OrganizationId: NotRequired[str],
UserIds: NotRequired[str],
Query: NotRequired[str],
Include: NotRequired[UserFilterTypeType], # (1)
Order: NotRequired[OrderTypeType], # (2)
Sort: NotRequired[UserSortTypeType], # (3)
Marker: NotRequired[str],
Limit: NotRequired[int],
Fields: NotRequired[str],
- See UserFilterTypeType
- See OrderTypeType
- See UserSortTypeType
LongRangeTypeTypeDef#
# LongRangeTypeTypeDef definition
class LongRangeTypeTypeDef(TypedDict):
StartValue: NotRequired[int],
EndValue: NotRequired[int],
SearchPrincipalTypeTypeDef#
# SearchPrincipalTypeTypeDef definition
class SearchPrincipalTypeTypeDef(TypedDict):
Id: str,
Roles: NotRequired[Sequence[PrincipalRoleTypeType]], # (1)
GetCurrentUserRequestRequestTypeDef#
# GetCurrentUserRequestRequestTypeDef definition
class GetCurrentUserRequestRequestTypeDef(TypedDict):
AuthenticationToken: str,
GetDocumentPathRequestRequestTypeDef#
# GetDocumentPathRequestRequestTypeDef definition
class GetDocumentPathRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Limit: NotRequired[int],
Fields: NotRequired[str],
Marker: NotRequired[str],
GetDocumentRequestRequestTypeDef#
# GetDocumentRequestRequestTypeDef definition
class GetDocumentRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
IncludeCustomMetadata: NotRequired[bool],
GetDocumentVersionRequestRequestTypeDef#
# GetDocumentVersionRequestRequestTypeDef definition
class GetDocumentVersionRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
Fields: NotRequired[str],
IncludeCustomMetadata: NotRequired[bool],
GetFolderPathRequestRequestTypeDef#
# GetFolderPathRequestRequestTypeDef definition
class GetFolderPathRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Limit: NotRequired[int],
Fields: NotRequired[str],
Marker: NotRequired[str],
GetFolderRequestRequestTypeDef#
# GetFolderRequestRequestTypeDef definition
class GetFolderRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
IncludeCustomMetadata: NotRequired[bool],
GetResourcesRequestRequestTypeDef#
# GetResourcesRequestRequestTypeDef definition
class GetResourcesRequestRequestTypeDef(TypedDict):
AuthenticationToken: NotRequired[str],
UserId: NotRequired[str],
CollectionType: NotRequired[ResourceCollectionTypeType], # (1)
Limit: NotRequired[int],
Marker: NotRequired[str],
UploadMetadataTypeDef#
# UploadMetadataTypeDef definition
class UploadMetadataTypeDef(TypedDict):
UploadUrl: NotRequired[str],
SignedHeaders: NotRequired[Dict[str, str]],
PermissionInfoTypeDef#
# PermissionInfoTypeDef definition
class PermissionInfoTypeDef(TypedDict):
Role: NotRequired[RoleTypeType], # (1)
Type: NotRequired[RolePermissionTypeType], # (2)
- See RoleTypeType
- See RolePermissionTypeType
RemoveAllResourcePermissionsRequestRequestTypeDef#
# RemoveAllResourcePermissionsRequestRequestTypeDef definition
class RemoveAllResourcePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
AuthenticationToken: NotRequired[str],
RemoveResourcePermissionRequestRequestTypeDef#
# RemoveResourcePermissionRequestRequestTypeDef definition
class RemoveResourcePermissionRequestRequestTypeDef(TypedDict):
ResourceId: str,
PrincipalId: str,
AuthenticationToken: NotRequired[str],
PrincipalType: NotRequired[PrincipalTypeType], # (1)
ResourcePathComponentTypeDef#
# ResourcePathComponentTypeDef definition
class ResourcePathComponentTypeDef(TypedDict):
Id: NotRequired[str],
Name: NotRequired[str],
RestoreDocumentVersionsRequestRequestTypeDef#
# RestoreDocumentVersionsRequestRequestTypeDef definition
class RestoreDocumentVersionsRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
SearchSortResultTypeDef#
# SearchSortResultTypeDef definition
class SearchSortResultTypeDef(TypedDict):
Field: NotRequired[OrderByFieldTypeType], # (1)
Order: NotRequired[SortOrderType], # (2)
- See OrderByFieldTypeType
- See SortOrderType
UpdateDocumentRequestRequestTypeDef#
# UpdateDocumentRequestRequestTypeDef definition
class UpdateDocumentRequestRequestTypeDef(TypedDict):
DocumentId: str,
AuthenticationToken: NotRequired[str],
Name: NotRequired[str],
ParentFolderId: NotRequired[str],
ResourceState: NotRequired[ResourceStateTypeType], # (1)
UpdateDocumentVersionRequestRequestTypeDef#
# UpdateDocumentVersionRequestRequestTypeDef definition
class UpdateDocumentVersionRequestRequestTypeDef(TypedDict):
DocumentId: str,
VersionId: str,
AuthenticationToken: NotRequired[str],
VersionStatus: NotRequired[DocumentVersionStatusType], # (1)
UpdateFolderRequestRequestTypeDef#
# UpdateFolderRequestRequestTypeDef definition
class UpdateFolderRequestRequestTypeDef(TypedDict):
FolderId: str,
AuthenticationToken: NotRequired[str],
Name: NotRequired[str],
ParentFolderId: NotRequired[str],
ResourceState: NotRequired[ResourceStateTypeType], # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResourceMetadataTypeDef#
# ResourceMetadataTypeDef definition
class ResourceMetadataTypeDef(TypedDict):
Type: NotRequired[ResourceTypeType], # (1)
Name: NotRequired[str],
OriginalName: NotRequired[str],
Id: NotRequired[str],
VersionId: NotRequired[str],
Owner: NotRequired[UserMetadataTypeDef], # (2)
ParentId: NotRequired[str],
- See ResourceTypeType
- See UserMetadataTypeDef
AddResourcePermissionsRequestRequestTypeDef#
# AddResourcePermissionsRequestRequestTypeDef definition
class AddResourcePermissionsRequestRequestTypeDef(TypedDict):
ResourceId: str,
Principals: Sequence[SharePrincipalTypeDef], # (1)
AuthenticationToken: NotRequired[str],
NotificationOptions: NotRequired[NotificationOptionsTypeDef], # (2)
AddResourcePermissionsResponseTypeDef#
# AddResourcePermissionsResponseTypeDef definition
class AddResourcePermissionsResponseTypeDef(TypedDict):
ShareResults: List[ShareResultTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateFolderResponseTypeDef#
# CreateFolderResponseTypeDef definition
class CreateFolderResponseTypeDef(TypedDict):
Metadata: FolderMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeRootFoldersResponseTypeDef#
# DescribeRootFoldersResponseTypeDef definition
class DescribeRootFoldersResponseTypeDef(TypedDict):
Folders: List[FolderMetadataTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetFolderResponseTypeDef#
# GetFolderResponseTypeDef definition
class GetFolderResponseTypeDef(TypedDict):
Metadata: FolderMetadataTypeDef, # (1)
CustomMetadata: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateNotificationSubscriptionResponseTypeDef#
# CreateNotificationSubscriptionResponseTypeDef definition
class CreateNotificationSubscriptionResponseTypeDef(TypedDict):
Subscription: SubscriptionTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeNotificationSubscriptionsResponseTypeDef#
# DescribeNotificationSubscriptionsResponseTypeDef definition
class DescribeNotificationSubscriptionsResponseTypeDef(TypedDict):
Subscriptions: List[SubscriptionTypeDef], # (1)
Marker: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef definition
class CreateUserRequestRequestTypeDef(TypedDict):
Username: str,
GivenName: str,
Surname: str,
Password: str,
OrganizationId: NotRequired[str],
EmailAddress: NotRequired[str],
TimeZoneId: NotRequired[str],
StorageRule: NotRequired[StorageRuleTypeTypeDef], # (1)
AuthenticationToken: NotRequired[str],