Skip to content

Type definitions#

Index > WorkDocs > 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,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

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)
  1. See PrincipalTypeType
  2. 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],
  1. See RoleTypeType
  2. 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],
  1. See CommentVisibilityTypeType

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],
  1. See ResourceStateTypeType

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)
  1. See SubscriptionProtocolTypeType
  2. See SubscriptionTypeType

SubscriptionTypeDef#

# SubscriptionTypeDef definition

class SubscriptionTypeDef(TypedDict):
    SubscriptionId: NotRequired[str],
    EndPoint: NotRequired[str],
    Protocol: NotRequired[SubscriptionProtocolTypeType],  # (1)
  1. See SubscriptionProtocolTypeType

StorageRuleTypeTypeDef#

# StorageRuleTypeTypeDef definition

class StorageRuleTypeTypeDef(TypedDict):
    StorageAllocatedInBytes: NotRequired[int],
    StorageType: NotRequired[StorageTypeType],  # (1)
  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)
  1. See DocumentStatusTypeType
  2. See DocumentThumbnailTypeType
  3. See DocumentSourceTypeType

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],
  1. See ResourceSortTypeType
  2. See OrderTypeType
  3. 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],
  1. See UserFilterTypeType
  2. See OrderTypeType
  3. 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)
  1. See PrincipalRoleTypeType

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