Skip to content

Typed dictionaries

Index > WorkDocs > Typed dictionaries

Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.

AbortDocumentVersionUploadRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import AbortDocumentVersionUploadRequestRequestTypeDef

def get_value() -> AbortDocumentVersionUploadRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
Definition
class AbortDocumentVersionUploadRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],

ActivateUserRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ActivateUserRequestRequestTypeDef

def get_value() -> ActivateUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
Definition
class ActivateUserRequestRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
Definition
class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

UserMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UserMetadataTypeDef

def get_value() -> UserMetadataTypeDef:
    return {
        "Id": ...,
    }
Definition
class UserMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    Username: NotRequired[str],
    GivenName: NotRequired[str],
    Surname: NotRequired[str],
    EmailAddress: NotRequired[str],

NotificationOptionsTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import NotificationOptionsTypeDef

def get_value() -> NotificationOptionsTypeDef:
    return {
        "SendEmail": ...,
    }
Definition
class NotificationOptionsTypeDef(TypedDict):
    SendEmail: NotRequired[bool],
    EmailMessage: NotRequired[str],

SharePrincipalTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import SharePrincipalTypeDef

def get_value() -> SharePrincipalTypeDef:
    return {
        "Id": ...,
        "Type": ...,
        "Role": ...,
    }
Definition
class SharePrincipalTypeDef(TypedDict):
    Id: str,
    Type: PrincipalTypeType,  # (1)
    Role: RoleTypeType,  # (2)
  1. See PrincipalTypeType
  2. See RoleTypeType

ShareResultTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ShareResultTypeDef

def get_value() -> ShareResultTypeDef:
    return {
        "PrincipalId": ...,
    }
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

Usage Example
from mypy_boto3_workdocs.type_defs import CreateCommentRequestRequestTypeDef

def get_value() -> CreateCommentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
        "Text": ...,
    }
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

Usage Example
from mypy_boto3_workdocs.type_defs import CreateCustomMetadataRequestRequestTypeDef

def get_value() -> CreateCustomMetadataRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "CustomMetadata": ...,
    }
Definition
class CreateCustomMetadataRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    CustomMetadata: Mapping[str, str],
    AuthenticationToken: NotRequired[str],
    VersionId: NotRequired[str],

CreateFolderRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateFolderRequestRequestTypeDef

def get_value() -> CreateFolderRequestRequestTypeDef:
    return {
        "ParentFolderId": ...,
    }
Definition
class CreateFolderRequestRequestTypeDef(TypedDict):
    ParentFolderId: str,
    AuthenticationToken: NotRequired[str],
    Name: NotRequired[str],

FolderMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import FolderMetadataTypeDef

def get_value() -> FolderMetadataTypeDef:
    return {
        "Id": ...,
    }
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

Usage Example
from mypy_boto3_workdocs.type_defs import CreateLabelsRequestRequestTypeDef

def get_value() -> CreateLabelsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "Labels": ...,
    }
Definition
class CreateLabelsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    Labels: Sequence[str],
    AuthenticationToken: NotRequired[str],

CreateNotificationSubscriptionRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateNotificationSubscriptionRequestRequestTypeDef

def get_value() -> CreateNotificationSubscriptionRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
        "Endpoint": ...,
        "Protocol": ...,
        "SubscriptionType": ...,
    }
Definition
class CreateNotificationSubscriptionRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Endpoint: str,
    Protocol: SubscriptionProtocolTypeType,  # (1)
    SubscriptionType: SubscriptionTypeType,  # (2)
  1. See SubscriptionProtocolTypeType
  2. See SubscriptionTypeType

SubscriptionTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import SubscriptionTypeDef

def get_value() -> SubscriptionTypeDef:
    return {
        "SubscriptionId": ...,
    }
Definition
class SubscriptionTypeDef(TypedDict):
    SubscriptionId: NotRequired[str],
    EndPoint: NotRequired[str],
    Protocol: NotRequired[SubscriptionProtocolTypeType],  # (1)
  1. See SubscriptionProtocolTypeType

StorageRuleTypeTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import StorageRuleTypeTypeDef

def get_value() -> StorageRuleTypeTypeDef:
    return {
        "StorageAllocatedInBytes": ...,
    }
Definition
class StorageRuleTypeTypeDef(TypedDict):
    StorageAllocatedInBytes: NotRequired[int],
    StorageType: NotRequired[StorageTypeType],  # (1)
  1. See StorageTypeType

DeactivateUserRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeactivateUserRequestRequestTypeDef

def get_value() -> DeactivateUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
Definition
class DeactivateUserRequestRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],

DeleteCommentRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteCommentRequestRequestTypeDef

def get_value() -> DeleteCommentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
        "CommentId": ...,
    }
Definition
class DeleteCommentRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    CommentId: str,
    AuthenticationToken: NotRequired[str],

DeleteCustomMetadataRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteCustomMetadataRequestRequestTypeDef

def get_value() -> DeleteCustomMetadataRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
Definition
class DeleteCustomMetadataRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    VersionId: NotRequired[str],
    Keys: NotRequired[Sequence[str]],
    DeleteAll: NotRequired[bool],

DeleteDocumentRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteDocumentRequestRequestTypeDef

def get_value() -> DeleteDocumentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
Definition
class DeleteDocumentRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],

DeleteFolderContentsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteFolderContentsRequestRequestTypeDef

def get_value() -> DeleteFolderContentsRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
Definition
class DeleteFolderContentsRequestRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],

DeleteFolderRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteFolderRequestRequestTypeDef

def get_value() -> DeleteFolderRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
Definition
class DeleteFolderRequestRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],

DeleteLabelsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteLabelsRequestRequestTypeDef

def get_value() -> DeleteLabelsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
Definition
class DeleteLabelsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    Labels: NotRequired[Sequence[str]],
    DeleteAll: NotRequired[bool],

DeleteNotificationSubscriptionRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteNotificationSubscriptionRequestRequestTypeDef

def get_value() -> DeleteNotificationSubscriptionRequestRequestTypeDef:
    return {
        "SubscriptionId": ...,
        "OrganizationId": ...,
    }
Definition
class DeleteNotificationSubscriptionRequestRequestTypeDef(TypedDict):
    SubscriptionId: str,
    OrganizationId: str,

DeleteUserRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DeleteUserRequestRequestTypeDef

def get_value() -> DeleteUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
Definition
class DeleteUserRequestRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeActivitiesRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeActivitiesRequestRequestTypeDef

def get_value() -> DescribeActivitiesRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class DescribeActivitiesRequestRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    OrganizationId: NotRequired[str],
    ActivityTypes: NotRequired[str],
    ResourceId: NotRequired[str],
    UserId: NotRequired[str],
    IncludeIndirectActivities: NotRequired[bool],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeCommentsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeCommentsRequestRequestTypeDef

def get_value() -> DescribeCommentsRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
Definition
class DescribeCommentsRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeDocumentVersionsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsRequestRequestTypeDef

def get_value() -> DescribeDocumentVersionsRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
Definition
class DescribeDocumentVersionsRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Marker: NotRequired[str],
    Limit: NotRequired[int],
    Include: NotRequired[str],
    Fields: NotRequired[str],

DocumentVersionMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DocumentVersionMetadataTypeDef

def get_value() -> DocumentVersionMetadataTypeDef:
    return {
        "Id": ...,
    }
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

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeFolderContentsRequestRequestTypeDef

def get_value() -> DescribeFolderContentsRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
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

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeGroupsRequestRequestTypeDef

def get_value() -> DescribeGroupsRequestRequestTypeDef:
    return {
        "SearchQuery": ...,
    }
Definition
class DescribeGroupsRequestRequestTypeDef(TypedDict):
    SearchQuery: str,
    AuthenticationToken: NotRequired[str],
    OrganizationId: NotRequired[str],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

GroupMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GroupMetadataTypeDef

def get_value() -> GroupMetadataTypeDef:
    return {
        "Id": ...,
    }
Definition
class GroupMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],

DescribeNotificationSubscriptionsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsRequestRequestTypeDef

def get_value() -> DescribeNotificationSubscriptionsRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
    }
Definition
class DescribeNotificationSubscriptionsRequestRequestTypeDef(TypedDict):
    OrganizationId: str,
    Marker: NotRequired[str],
    Limit: NotRequired[int],

DescribeResourcePermissionsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsRequestRequestTypeDef

def get_value() -> DescribeResourcePermissionsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
Definition
class DescribeResourcePermissionsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    PrincipalId: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeRootFoldersRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeRootFoldersRequestRequestTypeDef

def get_value() -> DescribeRootFoldersRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class DescribeRootFoldersRequestRequestTypeDef(TypedDict):
    AuthenticationToken: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeUsersRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeUsersRequestRequestTypeDef

def get_value() -> DescribeUsersRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
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

GetCurrentUserRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetCurrentUserRequestRequestTypeDef

def get_value() -> GetCurrentUserRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class GetCurrentUserRequestRequestTypeDef(TypedDict):
    AuthenticationToken: str,

GetDocumentPathRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetDocumentPathRequestRequestTypeDef

def get_value() -> GetDocumentPathRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
Definition
class GetDocumentPathRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Limit: NotRequired[int],
    Fields: NotRequired[str],
    Marker: NotRequired[str],

GetDocumentRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetDocumentRequestRequestTypeDef

def get_value() -> GetDocumentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
Definition
class GetDocumentRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    IncludeCustomMetadata: NotRequired[bool],

GetDocumentVersionRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetDocumentVersionRequestRequestTypeDef

def get_value() -> GetDocumentVersionRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
Definition
class GetDocumentVersionRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    Fields: NotRequired[str],
    IncludeCustomMetadata: NotRequired[bool],

GetFolderPathRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetFolderPathRequestRequestTypeDef

def get_value() -> GetFolderPathRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
Definition
class GetFolderPathRequestRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    Limit: NotRequired[int],
    Fields: NotRequired[str],
    Marker: NotRequired[str],

GetFolderRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetFolderRequestRequestTypeDef

def get_value() -> GetFolderRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
Definition
class GetFolderRequestRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    IncludeCustomMetadata: NotRequired[bool],

GetResourcesRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetResourcesRequestRequestTypeDef

def get_value() -> GetResourcesRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class GetResourcesRequestRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    UserId: NotRequired[str],
    CollectionType: NotRequired[ResourceCollectionTypeType],  # (1)
    Limit: NotRequired[int],
    Marker: NotRequired[str],
  1. See ResourceCollectionTypeType

InitiateDocumentVersionUploadRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import InitiateDocumentVersionUploadRequestRequestTypeDef

def get_value() -> InitiateDocumentVersionUploadRequestRequestTypeDef:
    return {
        "ParentFolderId": ...,
    }
Definition
class InitiateDocumentVersionUploadRequestRequestTypeDef(TypedDict):
    ParentFolderId: str,
    AuthenticationToken: NotRequired[str],
    Id: NotRequired[str],
    Name: NotRequired[str],
    ContentCreatedTimestamp: NotRequired[Union[datetime, str]],
    ContentModifiedTimestamp: NotRequired[Union[datetime, str]],
    ContentType: NotRequired[str],
    DocumentSizeInBytes: NotRequired[int],

UploadMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UploadMetadataTypeDef

def get_value() -> UploadMetadataTypeDef:
    return {
        "UploadUrl": ...,
    }
Definition
class UploadMetadataTypeDef(TypedDict):
    UploadUrl: NotRequired[str],
    SignedHeaders: NotRequired[Dict[str, str]],

PermissionInfoTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import PermissionInfoTypeDef

def get_value() -> PermissionInfoTypeDef:
    return {
        "Role": ...,
    }
Definition
class PermissionInfoTypeDef(TypedDict):
    Role: NotRequired[RoleTypeType],  # (1)
    Type: NotRequired[RolePermissionTypeType],  # (2)
  1. See RoleTypeType
  2. See RolePermissionTypeType

RemoveAllResourcePermissionsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import RemoveAllResourcePermissionsRequestRequestTypeDef

def get_value() -> RemoveAllResourcePermissionsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
Definition
class RemoveAllResourcePermissionsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],

RemoveResourcePermissionRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import RemoveResourcePermissionRequestRequestTypeDef

def get_value() -> RemoveResourcePermissionRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "PrincipalId": ...,
    }
Definition
class RemoveResourcePermissionRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    PrincipalId: str,
    AuthenticationToken: NotRequired[str],
    PrincipalType: NotRequired[PrincipalTypeType],  # (1)
  1. See PrincipalTypeType

ResourcePathComponentTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ResourcePathComponentTypeDef

def get_value() -> ResourcePathComponentTypeDef:
    return {
        "Id": ...,
    }
Definition
class ResourcePathComponentTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],

UpdateDocumentRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UpdateDocumentRequestRequestTypeDef

def get_value() -> UpdateDocumentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
Definition
class UpdateDocumentRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Name: NotRequired[str],
    ParentFolderId: NotRequired[str],
    ResourceState: NotRequired[ResourceStateTypeType],  # (1)
  1. See ResourceStateTypeType

UpdateDocumentVersionRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UpdateDocumentVersionRequestRequestTypeDef

def get_value() -> UpdateDocumentVersionRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
Definition
class UpdateDocumentVersionRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    VersionStatus: NotRequired[DocumentVersionStatusType],  # (1)
  1. See DocumentVersionStatusType

UpdateFolderRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UpdateFolderRequestRequestTypeDef

def get_value() -> UpdateFolderRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
Definition
class UpdateFolderRequestRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    Name: NotRequired[str],
    ParentFolderId: NotRequired[str],
    ResourceState: NotRequired[ResourceStateTypeType],  # (1)
  1. See ResourceStateTypeType

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResourceMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ResourceMetadataTypeDef

def get_value() -> ResourceMetadataTypeDef:
    return {
        "Type": ...,
    }
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],
  1. See ResourceTypeType
  2. See UserMetadataTypeDef

AddResourcePermissionsRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import AddResourcePermissionsRequestRequestTypeDef

def get_value() -> AddResourcePermissionsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "Principals": ...,
    }
Definition
class AddResourcePermissionsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    Principals: Sequence[SharePrincipalTypeDef],  # (1)
    AuthenticationToken: NotRequired[str],
    NotificationOptions: NotRequired[NotificationOptionsTypeDef],  # (2)
  1. See SharePrincipalTypeDef
  2. See NotificationOptionsTypeDef

AddResourcePermissionsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import AddResourcePermissionsResponseTypeDef

def get_value() -> AddResourcePermissionsResponseTypeDef:
    return {
        "ShareResults": ...,
        "ResponseMetadata": ...,
    }
Definition
class AddResourcePermissionsResponseTypeDef(TypedDict):
    ShareResults: List[ShareResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ShareResultTypeDef
  2. See ResponseMetadataTypeDef

CreateFolderResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateFolderResponseTypeDef

def get_value() -> CreateFolderResponseTypeDef:
    return {
        "Metadata": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateFolderResponseTypeDef(TypedDict):
    Metadata: FolderMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FolderMetadataTypeDef
  2. See ResponseMetadataTypeDef

DescribeRootFoldersResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeRootFoldersResponseTypeDef

def get_value() -> DescribeRootFoldersResponseTypeDef:
    return {
        "Folders": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeRootFoldersResponseTypeDef(TypedDict):
    Folders: List[FolderMetadataTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FolderMetadataTypeDef
  2. See ResponseMetadataTypeDef

GetFolderResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetFolderResponseTypeDef

def get_value() -> GetFolderResponseTypeDef:
    return {
        "Metadata": ...,
        "CustomMetadata": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetFolderResponseTypeDef(TypedDict):
    Metadata: FolderMetadataTypeDef,  # (1)
    CustomMetadata: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FolderMetadataTypeDef
  2. See ResponseMetadataTypeDef

CreateNotificationSubscriptionResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateNotificationSubscriptionResponseTypeDef

def get_value() -> CreateNotificationSubscriptionResponseTypeDef:
    return {
        "Subscription": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateNotificationSubscriptionResponseTypeDef(TypedDict):
    Subscription: SubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeNotificationSubscriptionsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsResponseTypeDef

def get_value() -> DescribeNotificationSubscriptionsResponseTypeDef:
    return {
        "Subscriptions": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeNotificationSubscriptionsResponseTypeDef(TypedDict):
    Subscriptions: List[SubscriptionTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriptionTypeDef
  2. See ResponseMetadataTypeDef

CreateUserRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateUserRequestRequestTypeDef

def get_value() -> CreateUserRequestRequestTypeDef:
    return {
        "Username": ...,
        "GivenName": ...,
        "Surname": ...,
        "Password": ...,
    }
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],
  1. See StorageRuleTypeTypeDef

UpdateUserRequestRequestTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UpdateUserRequestRequestTypeDef

def get_value() -> UpdateUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
Definition
class UpdateUserRequestRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],
    GivenName: NotRequired[str],
    Surname: NotRequired[str],
    Type: NotRequired[UserTypeType],  # (1)
    StorageRule: NotRequired[StorageRuleTypeTypeDef],  # (2)
    TimeZoneId: NotRequired[str],
    Locale: NotRequired[LocaleTypeType],  # (3)
    GrantPoweruserPrivileges: NotRequired[BooleanEnumTypeType],  # (4)
  1. See UserTypeType
  2. See StorageRuleTypeTypeDef
  3. See LocaleTypeType
  4. See BooleanEnumTypeType

UserStorageMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UserStorageMetadataTypeDef

def get_value() -> UserStorageMetadataTypeDef:
    return {
        "StorageUtilizedInBytes": ...,
    }
Definition
class UserStorageMetadataTypeDef(TypedDict):
    StorageUtilizedInBytes: NotRequired[int],
    StorageRule: NotRequired[StorageRuleTypeTypeDef],  # (1)
  1. See StorageRuleTypeTypeDef

DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef

def get_value() -> DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    StartTime: NotRequired[Union[datetime, str]],
    EndTime: NotRequired[Union[datetime, str]],
    OrganizationId: NotRequired[str],
    ActivityTypes: NotRequired[str],
    ResourceId: NotRequired[str],
    UserId: NotRequired[str],
    IncludeIndirectActivities: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeCommentsRequestDescribeCommentsPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeCommentsRequestDescribeCommentsPaginateTypeDef

def get_value() -> DescribeCommentsRequestDescribeCommentsPaginateTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
Definition
class DescribeCommentsRequestDescribeCommentsPaginateTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef

def get_value() -> DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef:
    return {
        "DocumentId": ...,
    }
Definition
class DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Include: NotRequired[str],
    Fields: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef

def get_value() -> DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef:
    return {
        "FolderId": ...,
    }
Definition
class DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    Sort: NotRequired[ResourceSortTypeType],  # (1)
    Order: NotRequired[OrderTypeType],  # (2)
    Type: NotRequired[FolderContentTypeType],  # (3)
    Include: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See ResourceSortTypeType
  2. See OrderTypeType
  3. See FolderContentTypeType
  4. See PaginatorConfigTypeDef

DescribeGroupsRequestDescribeGroupsPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeGroupsRequestDescribeGroupsPaginateTypeDef

def get_value() -> DescribeGroupsRequestDescribeGroupsPaginateTypeDef:
    return {
        "SearchQuery": ...,
    }
Definition
class DescribeGroupsRequestDescribeGroupsPaginateTypeDef(TypedDict):
    SearchQuery: str,
    AuthenticationToken: NotRequired[str],
    OrganizationId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef

def get_value() -> DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef:
    return {
        "OrganizationId": ...,
    }
Definition
class DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef(TypedDict):
    OrganizationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef

def get_value() -> DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef:
    return {
        "ResourceId": ...,
    }
Definition
class DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    PrincipalId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef

def get_value() -> DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef(TypedDict):
    AuthenticationToken: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeUsersRequestDescribeUsersPaginateTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeUsersRequestDescribeUsersPaginateTypeDef

def get_value() -> DescribeUsersRequestDescribeUsersPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }
Definition
class DescribeUsersRequestDescribeUsersPaginateTypeDef(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)
    Fields: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See UserFilterTypeType
  2. See OrderTypeType
  3. See UserSortTypeType
  4. See PaginatorConfigTypeDef

DescribeDocumentVersionsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsResponseTypeDef

def get_value() -> DescribeDocumentVersionsResponseTypeDef:
    return {
        "DocumentVersions": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeDocumentVersionsResponseTypeDef(TypedDict):
    DocumentVersions: List[DocumentVersionMetadataTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DocumentVersionMetadataTypeDef
  2. See ResponseMetadataTypeDef

DocumentMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DocumentMetadataTypeDef

def get_value() -> DocumentMetadataTypeDef:
    return {
        "Id": ...,
    }
Definition
class DocumentMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    CreatorId: NotRequired[str],
    ParentFolderId: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime],
    ModifiedTimestamp: NotRequired[datetime],
    LatestVersionMetadata: NotRequired[DocumentVersionMetadataTypeDef],  # (1)
    ResourceState: NotRequired[ResourceStateTypeType],  # (2)
    Labels: NotRequired[List[str]],
  1. See DocumentVersionMetadataTypeDef
  2. See ResourceStateTypeType

GetDocumentVersionResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetDocumentVersionResponseTypeDef

def get_value() -> GetDocumentVersionResponseTypeDef:
    return {
        "Metadata": ...,
        "CustomMetadata": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetDocumentVersionResponseTypeDef(TypedDict):
    Metadata: DocumentVersionMetadataTypeDef,  # (1)
    CustomMetadata: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DocumentVersionMetadataTypeDef
  2. See ResponseMetadataTypeDef

DescribeGroupsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeGroupsResponseTypeDef

def get_value() -> DescribeGroupsResponseTypeDef:
    return {
        "Groups": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeGroupsResponseTypeDef(TypedDict):
    Groups: List[GroupMetadataTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See GroupMetadataTypeDef
  2. See ResponseMetadataTypeDef

ParticipantsTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ParticipantsTypeDef

def get_value() -> ParticipantsTypeDef:
    return {
        "Users": ...,
    }
Definition
class ParticipantsTypeDef(TypedDict):
    Users: NotRequired[List[UserMetadataTypeDef]],  # (1)
    Groups: NotRequired[List[GroupMetadataTypeDef]],  # (2)
  1. See UserMetadataTypeDef
  2. See GroupMetadataTypeDef

PrincipalTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import PrincipalTypeDef

def get_value() -> PrincipalTypeDef:
    return {
        "Id": ...,
    }
Definition
class PrincipalTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[PrincipalTypeType],  # (1)
    Roles: NotRequired[List[PermissionInfoTypeDef]],  # (2)
  1. See PrincipalTypeType
  2. See PermissionInfoTypeDef

ResourcePathTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ResourcePathTypeDef

def get_value() -> ResourcePathTypeDef:
    return {
        "Components": ...,
    }
Definition
class ResourcePathTypeDef(TypedDict):
    Components: NotRequired[List[ResourcePathComponentTypeDef]],  # (1)
  1. See ResourcePathComponentTypeDef

UserTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UserTypeDef

def get_value() -> UserTypeDef:
    return {
        "Id": ...,
    }
Definition
class UserTypeDef(TypedDict):
    Id: NotRequired[str],
    Username: NotRequired[str],
    EmailAddress: NotRequired[str],
    GivenName: NotRequired[str],
    Surname: NotRequired[str],
    OrganizationId: NotRequired[str],
    RootFolderId: NotRequired[str],
    RecycleBinFolderId: NotRequired[str],
    Status: NotRequired[UserStatusTypeType],  # (1)
    Type: NotRequired[UserTypeType],  # (2)
    CreatedTimestamp: NotRequired[datetime],
    ModifiedTimestamp: NotRequired[datetime],
    TimeZoneId: NotRequired[str],
    Locale: NotRequired[LocaleTypeType],  # (3)
    Storage: NotRequired[UserStorageMetadataTypeDef],  # (4)
  1. See UserStatusTypeType
  2. See UserTypeType
  3. See LocaleTypeType
  4. See UserStorageMetadataTypeDef

DescribeFolderContentsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeFolderContentsResponseTypeDef

def get_value() -> DescribeFolderContentsResponseTypeDef:
    return {
        "Folders": ...,
        "Documents": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeFolderContentsResponseTypeDef(TypedDict):
    Folders: List[FolderMetadataTypeDef],  # (1)
    Documents: List[DocumentMetadataTypeDef],  # (2)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FolderMetadataTypeDef
  2. See DocumentMetadataTypeDef
  3. See ResponseMetadataTypeDef

GetDocumentResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetDocumentResponseTypeDef

def get_value() -> GetDocumentResponseTypeDef:
    return {
        "Metadata": ...,
        "CustomMetadata": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetDocumentResponseTypeDef(TypedDict):
    Metadata: DocumentMetadataTypeDef,  # (1)
    CustomMetadata: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DocumentMetadataTypeDef
  2. See ResponseMetadataTypeDef

GetResourcesResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetResourcesResponseTypeDef

def get_value() -> GetResourcesResponseTypeDef:
    return {
        "Folders": ...,
        "Documents": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetResourcesResponseTypeDef(TypedDict):
    Folders: List[FolderMetadataTypeDef],  # (1)
    Documents: List[DocumentMetadataTypeDef],  # (2)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See FolderMetadataTypeDef
  2. See DocumentMetadataTypeDef
  3. See ResponseMetadataTypeDef

InitiateDocumentVersionUploadResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import InitiateDocumentVersionUploadResponseTypeDef

def get_value() -> InitiateDocumentVersionUploadResponseTypeDef:
    return {
        "Metadata": ...,
        "UploadMetadata": ...,
        "ResponseMetadata": ...,
    }
Definition
class InitiateDocumentVersionUploadResponseTypeDef(TypedDict):
    Metadata: DocumentMetadataTypeDef,  # (1)
    UploadMetadata: UploadMetadataTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DocumentMetadataTypeDef
  2. See UploadMetadataTypeDef
  3. See ResponseMetadataTypeDef

DescribeResourcePermissionsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsResponseTypeDef

def get_value() -> DescribeResourcePermissionsResponseTypeDef:
    return {
        "Principals": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeResourcePermissionsResponseTypeDef(TypedDict):
    Principals: List[PrincipalTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PrincipalTypeDef
  2. See ResponseMetadataTypeDef

GetDocumentPathResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetDocumentPathResponseTypeDef

def get_value() -> GetDocumentPathResponseTypeDef:
    return {
        "Path": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetDocumentPathResponseTypeDef(TypedDict):
    Path: ResourcePathTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePathTypeDef
  2. See ResponseMetadataTypeDef

GetFolderPathResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetFolderPathResponseTypeDef

def get_value() -> GetFolderPathResponseTypeDef:
    return {
        "Path": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetFolderPathResponseTypeDef(TypedDict):
    Path: ResourcePathTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ResourcePathTypeDef
  2. See ResponseMetadataTypeDef

ActivateUserResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ActivateUserResponseTypeDef

def get_value() -> ActivateUserResponseTypeDef:
    return {
        "User": ...,
        "ResponseMetadata": ...,
    }
Definition
class ActivateUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

CommentMetadataTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CommentMetadataTypeDef

def get_value() -> CommentMetadataTypeDef:
    return {
        "CommentId": ...,
    }
Definition
class CommentMetadataTypeDef(TypedDict):
    CommentId: NotRequired[str],
    Contributor: NotRequired[UserTypeDef],  # (1)
    CreatedTimestamp: NotRequired[datetime],
    CommentStatus: NotRequired[CommentStatusTypeType],  # (2)
    RecipientId: NotRequired[str],
  1. See UserTypeDef
  2. See CommentStatusTypeType

CommentTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CommentTypeDef

def get_value() -> CommentTypeDef:
    return {
        "CommentId": ...,
    }
Definition
class CommentTypeDef(TypedDict):
    CommentId: str,
    ParentId: NotRequired[str],
    ThreadId: NotRequired[str],
    Text: NotRequired[str],
    Contributor: NotRequired[UserTypeDef],  # (1)
    CreatedTimestamp: NotRequired[datetime],
    Status: NotRequired[CommentStatusTypeType],  # (2)
    Visibility: NotRequired[CommentVisibilityTypeType],  # (3)
    RecipientId: NotRequired[str],
  1. See UserTypeDef
  2. See CommentStatusTypeType
  3. See CommentVisibilityTypeType

CreateUserResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateUserResponseTypeDef

def get_value() -> CreateUserResponseTypeDef:
    return {
        "User": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

DescribeUsersResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeUsersResponseTypeDef

def get_value() -> DescribeUsersResponseTypeDef:
    return {
        "Users": ...,
        "TotalNumberOfUsers": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeUsersResponseTypeDef(TypedDict):
    Users: List[UserTypeDef],  # (1)
    TotalNumberOfUsers: int,
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

GetCurrentUserResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import GetCurrentUserResponseTypeDef

def get_value() -> GetCurrentUserResponseTypeDef:
    return {
        "User": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetCurrentUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

UpdateUserResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import UpdateUserResponseTypeDef

def get_value() -> UpdateUserResponseTypeDef:
    return {
        "User": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UserTypeDef
  2. See ResponseMetadataTypeDef

ActivityTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import ActivityTypeDef

def get_value() -> ActivityTypeDef:
    return {
        "Type": ...,
    }
Definition
class ActivityTypeDef(TypedDict):
    Type: NotRequired[ActivityTypeType],  # (1)
    TimeStamp: NotRequired[datetime],
    IsIndirectActivity: NotRequired[bool],
    OrganizationId: NotRequired[str],
    Initiator: NotRequired[UserMetadataTypeDef],  # (2)
    Participants: NotRequired[ParticipantsTypeDef],  # (3)
    ResourceMetadata: NotRequired[ResourceMetadataTypeDef],  # (4)
    OriginalParent: NotRequired[ResourceMetadataTypeDef],  # (4)
    CommentMetadata: NotRequired[CommentMetadataTypeDef],  # (6)
  1. See ActivityTypeType
  2. See UserMetadataTypeDef
  3. See ParticipantsTypeDef
  4. See ResourceMetadataTypeDef
  5. See ResourceMetadataTypeDef
  6. See CommentMetadataTypeDef

CreateCommentResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import CreateCommentResponseTypeDef

def get_value() -> CreateCommentResponseTypeDef:
    return {
        "Comment": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateCommentResponseTypeDef(TypedDict):
    Comment: CommentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CommentTypeDef
  2. See ResponseMetadataTypeDef

DescribeCommentsResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeCommentsResponseTypeDef

def get_value() -> DescribeCommentsResponseTypeDef:
    return {
        "Comments": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeCommentsResponseTypeDef(TypedDict):
    Comments: List[CommentTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CommentTypeDef
  2. See ResponseMetadataTypeDef

DescribeActivitiesResponseTypeDef

Usage Example
from mypy_boto3_workdocs.type_defs import DescribeActivitiesResponseTypeDef

def get_value() -> DescribeActivitiesResponseTypeDef:
    return {
        "UserActivities": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
Definition
class DescribeActivitiesResponseTypeDef(TypedDict):
    UserActivities: List[ActivityTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ActivityTypeDef
  2. See ResponseMetadataTypeDef