Type definitions

Index > WorkDocs > Type definitions

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

TimestampTypeDef

# TimestampTypeDef Union usage example

from mypy_boto3_workdocs.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

AbortDocumentVersionUploadRequestTypeDef

# AbortDocumentVersionUploadRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import AbortDocumentVersionUploadRequestTypeDef


def get_value() -> AbortDocumentVersionUploadRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# AbortDocumentVersionUploadRequestTypeDef definition

class AbortDocumentVersionUploadRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],

ActivateUserRequestTypeDef

# ActivateUserRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ActivateUserRequestTypeDef


def get_value() -> ActivateUserRequestTypeDef:
    return {
        "UserId": ...,
    }


# ActivateUserRequestTypeDef definition

class ActivateUserRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

UserMetadataTypeDef

# UserMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UserMetadataTypeDef


def get_value() -> UserMetadataTypeDef:
    return {
        "Id": ...,
    }


# UserMetadataTypeDef definition

class UserMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    Username: NotRequired[str],
    GivenName: NotRequired[str],
    Surname: NotRequired[str],
    EmailAddress: NotRequired[str],

NotificationOptionsTypeDef

# NotificationOptionsTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import NotificationOptionsTypeDef


def get_value() -> NotificationOptionsTypeDef:
    return {
        "SendEmail": ...,
    }


# NotificationOptionsTypeDef definition

class NotificationOptionsTypeDef(TypedDict):
    SendEmail: NotRequired[bool],
    EmailMessage: NotRequired[str],

SharePrincipalTypeDef

# SharePrincipalTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SharePrincipalTypeDef


def get_value() -> SharePrincipalTypeDef:
    return {
        "Id": ...,
    }


# SharePrincipalTypeDef definition

class SharePrincipalTypeDef(TypedDict):
    Id: str,
    Type: PrincipalTypeType,  # (1)
    Role: RoleTypeType,  # (2)

1. See PrincipalTypeType
2. See RoleTypeType

ShareResultTypeDef

# ShareResultTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ShareResultTypeDef


def get_value() -> ShareResultTypeDef:
    return {
        "PrincipalId": ...,
    }


# 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

CreateCommentRequestTypeDef

# CreateCommentRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateCommentRequestTypeDef


def get_value() -> CreateCommentRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# CreateCommentRequestTypeDef definition

class CreateCommentRequestTypeDef(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

CreateCustomMetadataRequestTypeDef

# CreateCustomMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateCustomMetadataRequestTypeDef


def get_value() -> CreateCustomMetadataRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# CreateCustomMetadataRequestTypeDef definition

class CreateCustomMetadataRequestTypeDef(TypedDict):
    ResourceId: str,
    CustomMetadata: Mapping[str, str],
    AuthenticationToken: NotRequired[str],
    VersionId: NotRequired[str],

CreateFolderRequestTypeDef

# CreateFolderRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateFolderRequestTypeDef


def get_value() -> CreateFolderRequestTypeDef:
    return {
        "ParentFolderId": ...,
    }


# CreateFolderRequestTypeDef definition

class CreateFolderRequestTypeDef(TypedDict):
    ParentFolderId: str,
    AuthenticationToken: NotRequired[str],
    Name: NotRequired[str],

FolderMetadataTypeDef

# FolderMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import FolderMetadataTypeDef


def get_value() -> FolderMetadataTypeDef:
    return {
        "Id": ...,
    }


# FolderMetadataTypeDef definition

class FolderMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    CreatorId: NotRequired[str],
    ParentFolderId: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime.datetime],
    ModifiedTimestamp: NotRequired[datetime.datetime],
    ResourceState: NotRequired[ResourceStateTypeType],  # (1)
    Signature: NotRequired[str],
    Labels: NotRequired[List[str]],
    Size: NotRequired[int],
    LatestVersionSize: NotRequired[int],

1. See ResourceStateTypeType

CreateLabelsRequestTypeDef

# CreateLabelsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateLabelsRequestTypeDef


def get_value() -> CreateLabelsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# CreateLabelsRequestTypeDef definition

class CreateLabelsRequestTypeDef(TypedDict):
    ResourceId: str,
    Labels: Sequence[str],
    AuthenticationToken: NotRequired[str],

CreateNotificationSubscriptionRequestTypeDef

# CreateNotificationSubscriptionRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateNotificationSubscriptionRequestTypeDef


def get_value() -> CreateNotificationSubscriptionRequestTypeDef:
    return {
        "OrganizationId": ...,
    }


# CreateNotificationSubscriptionRequestTypeDef definition

class CreateNotificationSubscriptionRequestTypeDef(TypedDict):
    OrganizationId: str,
    Endpoint: str,
    Protocol: SubscriptionProtocolTypeType,  # (1)
    SubscriptionType: SubscriptionTypeType,  # (2)

1. See SubscriptionProtocolTypeType
2. See SubscriptionTypeType

SubscriptionTypeDef

# SubscriptionTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SubscriptionTypeDef


def get_value() -> SubscriptionTypeDef:
    return {
        "SubscriptionId": ...,
    }


# SubscriptionTypeDef definition

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

1. See SubscriptionProtocolTypeType

StorageRuleTypeTypeDef

# StorageRuleTypeTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import StorageRuleTypeTypeDef


def get_value() -> StorageRuleTypeTypeDef:
    return {
        "StorageAllocatedInBytes": ...,
    }


# StorageRuleTypeTypeDef definition

class StorageRuleTypeTypeDef(TypedDict):
    StorageAllocatedInBytes: NotRequired[int],
    StorageType: NotRequired[StorageTypeType],  # (1)

1. See StorageTypeType

DeactivateUserRequestTypeDef

# DeactivateUserRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeactivateUserRequestTypeDef


def get_value() -> DeactivateUserRequestTypeDef:
    return {
        "UserId": ...,
    }


# DeactivateUserRequestTypeDef definition

class DeactivateUserRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],

DeleteCommentRequestTypeDef

# DeleteCommentRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteCommentRequestTypeDef


def get_value() -> DeleteCommentRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# DeleteCommentRequestTypeDef definition

class DeleteCommentRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    CommentId: str,
    AuthenticationToken: NotRequired[str],

DeleteCustomMetadataRequestTypeDef

# DeleteCustomMetadataRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteCustomMetadataRequestTypeDef


def get_value() -> DeleteCustomMetadataRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DeleteCustomMetadataRequestTypeDef definition

class DeleteCustomMetadataRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    VersionId: NotRequired[str],
    Keys: NotRequired[Sequence[str]],
    DeleteAll: NotRequired[bool],

DeleteDocumentRequestTypeDef

# DeleteDocumentRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteDocumentRequestTypeDef


def get_value() -> DeleteDocumentRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# DeleteDocumentRequestTypeDef definition

class DeleteDocumentRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],

DeleteDocumentVersionRequestTypeDef

# DeleteDocumentVersionRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteDocumentVersionRequestTypeDef


def get_value() -> DeleteDocumentVersionRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# DeleteDocumentVersionRequestTypeDef definition

class DeleteDocumentVersionRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    DeletePriorVersions: bool,
    AuthenticationToken: NotRequired[str],

DeleteFolderContentsRequestTypeDef

# DeleteFolderContentsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteFolderContentsRequestTypeDef


def get_value() -> DeleteFolderContentsRequestTypeDef:
    return {
        "FolderId": ...,
    }


# DeleteFolderContentsRequestTypeDef definition

class DeleteFolderContentsRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],

DeleteFolderRequestTypeDef

# DeleteFolderRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteFolderRequestTypeDef


def get_value() -> DeleteFolderRequestTypeDef:
    return {
        "FolderId": ...,
    }


# DeleteFolderRequestTypeDef definition

class DeleteFolderRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],

DeleteLabelsRequestTypeDef

# DeleteLabelsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteLabelsRequestTypeDef


def get_value() -> DeleteLabelsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DeleteLabelsRequestTypeDef definition

class DeleteLabelsRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    Labels: NotRequired[Sequence[str]],
    DeleteAll: NotRequired[bool],

DeleteNotificationSubscriptionRequestTypeDef

# DeleteNotificationSubscriptionRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteNotificationSubscriptionRequestTypeDef


def get_value() -> DeleteNotificationSubscriptionRequestTypeDef:
    return {
        "SubscriptionId": ...,
    }


# DeleteNotificationSubscriptionRequestTypeDef definition

class DeleteNotificationSubscriptionRequestTypeDef(TypedDict):
    SubscriptionId: str,
    OrganizationId: str,

DeleteUserRequestTypeDef

# DeleteUserRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DeleteUserRequestTypeDef


def get_value() -> DeleteUserRequestTypeDef:
    return {
        "UserId": ...,
    }


# DeleteUserRequestTypeDef definition

class DeleteUserRequestTypeDef(TypedDict):
    UserId: str,
    AuthenticationToken: NotRequired[str],

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeCommentsRequestTypeDef

# DescribeCommentsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeCommentsRequestTypeDef


def get_value() -> DescribeCommentsRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# DescribeCommentsRequestTypeDef definition

class DescribeCommentsRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeDocumentVersionsRequestTypeDef

# DescribeDocumentVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsRequestTypeDef


def get_value() -> DescribeDocumentVersionsRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# DescribeDocumentVersionsRequestTypeDef definition

class DescribeDocumentVersionsRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Marker: NotRequired[str],
    Limit: NotRequired[int],
    Include: NotRequired[str],
    Fields: NotRequired[str],

DocumentVersionMetadataTypeDef

# DocumentVersionMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DocumentVersionMetadataTypeDef


def get_value() -> DocumentVersionMetadataTypeDef:
    return {
        "Id": ...,
    }


# 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.datetime],
    ModifiedTimestamp: NotRequired[datetime.datetime],
    ContentCreatedTimestamp: NotRequired[datetime.datetime],
    ContentModifiedTimestamp: NotRequired[datetime.datetime],
    CreatorId: NotRequired[str],
    Thumbnail: NotRequired[Dict[DocumentThumbnailTypeType, str]],  # (2)
    Source: NotRequired[Dict[DocumentSourceTypeType, str]],  # (3)

1. See DocumentStatusTypeType
2. See Dict[DocumentThumbnailTypeType, str]
3. See Dict[DocumentSourceTypeType, str]

DescribeFolderContentsRequestTypeDef

# DescribeFolderContentsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeFolderContentsRequestTypeDef


def get_value() -> DescribeFolderContentsRequestTypeDef:
    return {
        "FolderId": ...,
    }


# DescribeFolderContentsRequestTypeDef definition

class DescribeFolderContentsRequestTypeDef(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

DescribeGroupsRequestTypeDef

# DescribeGroupsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeGroupsRequestTypeDef


def get_value() -> DescribeGroupsRequestTypeDef:
    return {
        "SearchQuery": ...,
    }


# DescribeGroupsRequestTypeDef definition

class DescribeGroupsRequestTypeDef(TypedDict):
    SearchQuery: str,
    AuthenticationToken: NotRequired[str],
    OrganizationId: NotRequired[str],
    Marker: NotRequired[str],
    Limit: NotRequired[int],

GroupMetadataTypeDef

# GroupMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GroupMetadataTypeDef


def get_value() -> GroupMetadataTypeDef:
    return {
        "Id": ...,
    }


# GroupMetadataTypeDef definition

class GroupMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],

DescribeNotificationSubscriptionsRequestTypeDef

# DescribeNotificationSubscriptionsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsRequestTypeDef


def get_value() -> DescribeNotificationSubscriptionsRequestTypeDef:
    return {
        "OrganizationId": ...,
    }


# DescribeNotificationSubscriptionsRequestTypeDef definition

class DescribeNotificationSubscriptionsRequestTypeDef(TypedDict):
    OrganizationId: str,
    Marker: NotRequired[str],
    Limit: NotRequired[int],

DescribeResourcePermissionsRequestTypeDef

# DescribeResourcePermissionsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsRequestTypeDef


def get_value() -> DescribeResourcePermissionsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# DescribeResourcePermissionsRequestTypeDef definition

class DescribeResourcePermissionsRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    PrincipalId: NotRequired[str],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeRootFoldersRequestTypeDef

# DescribeRootFoldersRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeRootFoldersRequestTypeDef


def get_value() -> DescribeRootFoldersRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# DescribeRootFoldersRequestTypeDef definition

class DescribeRootFoldersRequestTypeDef(TypedDict):
    AuthenticationToken: str,
    Limit: NotRequired[int],
    Marker: NotRequired[str],

DescribeUsersRequestTypeDef

# DescribeUsersRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeUsersRequestTypeDef


def get_value() -> DescribeUsersRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# DescribeUsersRequestTypeDef definition

class DescribeUsersRequestTypeDef(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 TypedDict usage example

from mypy_boto3_workdocs.type_defs import LongRangeTypeTypeDef


def get_value() -> LongRangeTypeTypeDef:
    return {
        "StartValue": ...,
    }


# LongRangeTypeTypeDef definition

class LongRangeTypeTypeDef(TypedDict):
    StartValue: NotRequired[int],
    EndValue: NotRequired[int],

SearchPrincipalTypeTypeDef

# SearchPrincipalTypeTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SearchPrincipalTypeTypeDef


def get_value() -> SearchPrincipalTypeTypeDef:
    return {
        "Id": ...,
    }


# SearchPrincipalTypeTypeDef definition

class SearchPrincipalTypeTypeDef(TypedDict):
    Id: str,
    Roles: NotRequired[Sequence[PrincipalRoleTypeType]],  # (1)

1. See Sequence[PrincipalRoleTypeType]

GetCurrentUserRequestTypeDef

# GetCurrentUserRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetCurrentUserRequestTypeDef


def get_value() -> GetCurrentUserRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# GetCurrentUserRequestTypeDef definition

class GetCurrentUserRequestTypeDef(TypedDict):
    AuthenticationToken: str,

GetDocumentPathRequestTypeDef

# GetDocumentPathRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetDocumentPathRequestTypeDef


def get_value() -> GetDocumentPathRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# GetDocumentPathRequestTypeDef definition

class GetDocumentPathRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Limit: NotRequired[int],
    Fields: NotRequired[str],
    Marker: NotRequired[str],

GetDocumentRequestTypeDef

# GetDocumentRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetDocumentRequestTypeDef


def get_value() -> GetDocumentRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# GetDocumentRequestTypeDef definition

class GetDocumentRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    IncludeCustomMetadata: NotRequired[bool],

GetDocumentVersionRequestTypeDef

# GetDocumentVersionRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetDocumentVersionRequestTypeDef


def get_value() -> GetDocumentVersionRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# GetDocumentVersionRequestTypeDef definition

class GetDocumentVersionRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    Fields: NotRequired[str],
    IncludeCustomMetadata: NotRequired[bool],

GetFolderPathRequestTypeDef

# GetFolderPathRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetFolderPathRequestTypeDef


def get_value() -> GetFolderPathRequestTypeDef:
    return {
        "FolderId": ...,
    }


# GetFolderPathRequestTypeDef definition

class GetFolderPathRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    Limit: NotRequired[int],
    Fields: NotRequired[str],
    Marker: NotRequired[str],

GetFolderRequestTypeDef

# GetFolderRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetFolderRequestTypeDef


def get_value() -> GetFolderRequestTypeDef:
    return {
        "FolderId": ...,
    }


# GetFolderRequestTypeDef definition

class GetFolderRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    IncludeCustomMetadata: NotRequired[bool],

GetResourcesRequestTypeDef

# GetResourcesRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetResourcesRequestTypeDef


def get_value() -> GetResourcesRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# GetResourcesRequestTypeDef definition

class GetResourcesRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    UserId: NotRequired[str],
    CollectionType: NotRequired[ResourceCollectionTypeType],  # (1)
    Limit: NotRequired[int],
    Marker: NotRequired[str],

1. See ResourceCollectionTypeType

UploadMetadataTypeDef

# UploadMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UploadMetadataTypeDef


def get_value() -> UploadMetadataTypeDef:
    return {
        "UploadUrl": ...,
    }


# UploadMetadataTypeDef definition

class UploadMetadataTypeDef(TypedDict):
    UploadUrl: NotRequired[str],
    SignedHeaders: NotRequired[Dict[str, str]],

PermissionInfoTypeDef

# PermissionInfoTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import PermissionInfoTypeDef


def get_value() -> PermissionInfoTypeDef:
    return {
        "Role": ...,
    }


# PermissionInfoTypeDef definition

class PermissionInfoTypeDef(TypedDict):
    Role: NotRequired[RoleTypeType],  # (1)
    Type: NotRequired[RolePermissionTypeType],  # (2)

1. See RoleTypeType
2. See RolePermissionTypeType

RemoveAllResourcePermissionsRequestTypeDef

# RemoveAllResourcePermissionsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import RemoveAllResourcePermissionsRequestTypeDef


def get_value() -> RemoveAllResourcePermissionsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# RemoveAllResourcePermissionsRequestTypeDef definition

class RemoveAllResourcePermissionsRequestTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],

RemoveResourcePermissionRequestTypeDef

# RemoveResourcePermissionRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import RemoveResourcePermissionRequestTypeDef


def get_value() -> RemoveResourcePermissionRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# RemoveResourcePermissionRequestTypeDef definition

class RemoveResourcePermissionRequestTypeDef(TypedDict):
    ResourceId: str,
    PrincipalId: str,
    AuthenticationToken: NotRequired[str],
    PrincipalType: NotRequired[PrincipalTypeType],  # (1)

1. See PrincipalTypeType

ResourcePathComponentTypeDef

# ResourcePathComponentTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ResourcePathComponentTypeDef


def get_value() -> ResourcePathComponentTypeDef:
    return {
        "Id": ...,
    }


# ResourcePathComponentTypeDef definition

class ResourcePathComponentTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],

RestoreDocumentVersionsRequestTypeDef

# RestoreDocumentVersionsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import RestoreDocumentVersionsRequestTypeDef


def get_value() -> RestoreDocumentVersionsRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# RestoreDocumentVersionsRequestTypeDef definition

class RestoreDocumentVersionsRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],

SearchSortResultTypeDef

# SearchSortResultTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SearchSortResultTypeDef


def get_value() -> SearchSortResultTypeDef:
    return {
        "Field": ...,
    }


# SearchSortResultTypeDef definition

class SearchSortResultTypeDef(TypedDict):
    Field: NotRequired[OrderByFieldTypeType],  # (1)
    Order: NotRequired[SortOrderType],  # (2)

1. See OrderByFieldTypeType
2. See SortOrderType

UpdateDocumentRequestTypeDef

# UpdateDocumentRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UpdateDocumentRequestTypeDef


def get_value() -> UpdateDocumentRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# UpdateDocumentRequestTypeDef definition

class UpdateDocumentRequestTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Name: NotRequired[str],
    ParentFolderId: NotRequired[str],
    ResourceState: NotRequired[ResourceStateTypeType],  # (1)

1. See ResourceStateTypeType

UpdateDocumentVersionRequestTypeDef

# UpdateDocumentVersionRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UpdateDocumentVersionRequestTypeDef


def get_value() -> UpdateDocumentVersionRequestTypeDef:
    return {
        "DocumentId": ...,
    }


# UpdateDocumentVersionRequestTypeDef definition

class UpdateDocumentVersionRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    VersionStatus: NotRequired[DocumentVersionStatusType],  # (1)

1. See DocumentVersionStatusType

UpdateFolderRequestTypeDef

# UpdateFolderRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UpdateFolderRequestTypeDef


def get_value() -> UpdateFolderRequestTypeDef:
    return {
        "FolderId": ...,
    }


# UpdateFolderRequestTypeDef definition

class UpdateFolderRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    Name: NotRequired[str],
    ParentFolderId: NotRequired[str],
    ResourceState: NotRequired[ResourceStateTypeType],  # (1)

1. See ResourceStateTypeType

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

ResourceMetadataTypeDef

# ResourceMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ResourceMetadataTypeDef


def get_value() -> ResourceMetadataTypeDef:
    return {
        "Type": ...,
    }


# 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],

1. See ResourceTypeType
2. See UserMetadataTypeDef

AddResourcePermissionsRequestTypeDef

# AddResourcePermissionsRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import AddResourcePermissionsRequestTypeDef


def get_value() -> AddResourcePermissionsRequestTypeDef:
    return {
        "ResourceId": ...,
    }


# AddResourcePermissionsRequestTypeDef definition

class AddResourcePermissionsRequestTypeDef(TypedDict):
    ResourceId: str,
    Principals: Sequence[SharePrincipalTypeDef],  # (1)
    AuthenticationToken: NotRequired[str],
    NotificationOptions: NotRequired[NotificationOptionsTypeDef],  # (2)

1. See Sequence[SharePrincipalTypeDef]
2. See NotificationOptionsTypeDef

AddResourcePermissionsResponseTypeDef

# AddResourcePermissionsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import AddResourcePermissionsResponseTypeDef


def get_value() -> AddResourcePermissionsResponseTypeDef:
    return {
        "ShareResults": ...,
    }


# AddResourcePermissionsResponseTypeDef definition

class AddResourcePermissionsResponseTypeDef(TypedDict):
    ShareResults: List[ShareResultTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[ShareResultTypeDef]
2. See ResponseMetadataTypeDef

CreateFolderResponseTypeDef

# CreateFolderResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateFolderResponseTypeDef


def get_value() -> CreateFolderResponseTypeDef:
    return {
        "Metadata": ...,
    }


# CreateFolderResponseTypeDef definition

class CreateFolderResponseTypeDef(TypedDict):
    Metadata: FolderMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FolderMetadataTypeDef
2. See ResponseMetadataTypeDef

DescribeRootFoldersResponseTypeDef

# DescribeRootFoldersResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeRootFoldersResponseTypeDef


def get_value() -> DescribeRootFoldersResponseTypeDef:
    return {
        "Folders": ...,
    }


# DescribeRootFoldersResponseTypeDef definition

class DescribeRootFoldersResponseTypeDef(TypedDict):
    Folders: List[FolderMetadataTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[FolderMetadataTypeDef]
2. See ResponseMetadataTypeDef

GetFolderResponseTypeDef

# GetFolderResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetFolderResponseTypeDef


def get_value() -> GetFolderResponseTypeDef:
    return {
        "Metadata": ...,
    }


# GetFolderResponseTypeDef definition

class GetFolderResponseTypeDef(TypedDict):
    Metadata: FolderMetadataTypeDef,  # (1)
    CustomMetadata: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See FolderMetadataTypeDef
2. See ResponseMetadataTypeDef

CreateNotificationSubscriptionResponseTypeDef

# CreateNotificationSubscriptionResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateNotificationSubscriptionResponseTypeDef


def get_value() -> CreateNotificationSubscriptionResponseTypeDef:
    return {
        "Subscription": ...,
    }


# CreateNotificationSubscriptionResponseTypeDef definition

class CreateNotificationSubscriptionResponseTypeDef(TypedDict):
    Subscription: SubscriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See SubscriptionTypeDef
2. See ResponseMetadataTypeDef

DescribeNotificationSubscriptionsResponseTypeDef

# DescribeNotificationSubscriptionsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsResponseTypeDef


def get_value() -> DescribeNotificationSubscriptionsResponseTypeDef:
    return {
        "Subscriptions": ...,
    }


# DescribeNotificationSubscriptionsResponseTypeDef definition

class DescribeNotificationSubscriptionsResponseTypeDef(TypedDict):
    Subscriptions: List[SubscriptionTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[SubscriptionTypeDef]
2. See ResponseMetadataTypeDef

CreateUserRequestTypeDef

# CreateUserRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateUserRequestTypeDef


def get_value() -> CreateUserRequestTypeDef:
    return {
        "Username": ...,
    }


# CreateUserRequestTypeDef definition

class CreateUserRequestTypeDef(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

UpdateUserRequestTypeDef

# UpdateUserRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UpdateUserRequestTypeDef


def get_value() -> UpdateUserRequestTypeDef:
    return {
        "UserId": ...,
    }


# UpdateUserRequestTypeDef definition

class UpdateUserRequestTypeDef(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

# UserStorageMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UserStorageMetadataTypeDef


def get_value() -> UserStorageMetadataTypeDef:
    return {
        "StorageUtilizedInBytes": ...,
    }


# UserStorageMetadataTypeDef definition

class UserStorageMetadataTypeDef(TypedDict):
    StorageUtilizedInBytes: NotRequired[int],
    StorageRule: NotRequired[StorageRuleTypeTypeDef],  # (1)

1. See StorageRuleTypeTypeDef

DateRangeTypeTypeDef

# DateRangeTypeTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DateRangeTypeTypeDef


def get_value() -> DateRangeTypeTypeDef:
    return {
        "StartValue": ...,
    }


# DateRangeTypeTypeDef definition

class DateRangeTypeTypeDef(TypedDict):
    StartValue: NotRequired[TimestampTypeDef],
    EndValue: NotRequired[TimestampTypeDef],

DescribeActivitiesRequestTypeDef

# DescribeActivitiesRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeActivitiesRequestTypeDef


def get_value() -> DescribeActivitiesRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# DescribeActivitiesRequestTypeDef definition

class DescribeActivitiesRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    StartTime: NotRequired[TimestampTypeDef],
    EndTime: NotRequired[TimestampTypeDef],
    OrganizationId: NotRequired[str],
    ActivityTypes: NotRequired[str],
    ResourceId: NotRequired[str],
    UserId: NotRequired[str],
    IncludeIndirectActivities: NotRequired[bool],
    Limit: NotRequired[int],
    Marker: NotRequired[str],

InitiateDocumentVersionUploadRequestTypeDef

# InitiateDocumentVersionUploadRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import InitiateDocumentVersionUploadRequestTypeDef


def get_value() -> InitiateDocumentVersionUploadRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# InitiateDocumentVersionUploadRequestTypeDef definition

class InitiateDocumentVersionUploadRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    Id: NotRequired[str],
    Name: NotRequired[str],
    ContentCreatedTimestamp: NotRequired[TimestampTypeDef],
    ContentModifiedTimestamp: NotRequired[TimestampTypeDef],
    ContentType: NotRequired[str],
    DocumentSizeInBytes: NotRequired[int],
    ParentFolderId: NotRequired[str],

DescribeActivitiesRequestPaginateTypeDef

# DescribeActivitiesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeActivitiesRequestPaginateTypeDef


def get_value() -> DescribeActivitiesRequestPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# DescribeActivitiesRequestPaginateTypeDef definition

class DescribeActivitiesRequestPaginateTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    StartTime: NotRequired[TimestampTypeDef],
    EndTime: NotRequired[TimestampTypeDef],
    OrganizationId: NotRequired[str],
    ActivityTypes: NotRequired[str],
    ResourceId: NotRequired[str],
    UserId: NotRequired[str],
    IncludeIndirectActivities: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeCommentsRequestPaginateTypeDef

# DescribeCommentsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeCommentsRequestPaginateTypeDef


def get_value() -> DescribeCommentsRequestPaginateTypeDef:
    return {
        "DocumentId": ...,
    }


# DescribeCommentsRequestPaginateTypeDef definition

class DescribeCommentsRequestPaginateTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    AuthenticationToken: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeDocumentVersionsRequestPaginateTypeDef

# DescribeDocumentVersionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsRequestPaginateTypeDef


def get_value() -> DescribeDocumentVersionsRequestPaginateTypeDef:
    return {
        "DocumentId": ...,
    }


# DescribeDocumentVersionsRequestPaginateTypeDef definition

class DescribeDocumentVersionsRequestPaginateTypeDef(TypedDict):
    DocumentId: str,
    AuthenticationToken: NotRequired[str],
    Include: NotRequired[str],
    Fields: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeFolderContentsRequestPaginateTypeDef

# DescribeFolderContentsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeFolderContentsRequestPaginateTypeDef


def get_value() -> DescribeFolderContentsRequestPaginateTypeDef:
    return {
        "FolderId": ...,
    }


# DescribeFolderContentsRequestPaginateTypeDef definition

class DescribeFolderContentsRequestPaginateTypeDef(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

DescribeGroupsRequestPaginateTypeDef

# DescribeGroupsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeGroupsRequestPaginateTypeDef


def get_value() -> DescribeGroupsRequestPaginateTypeDef:
    return {
        "SearchQuery": ...,
    }


# DescribeGroupsRequestPaginateTypeDef definition

class DescribeGroupsRequestPaginateTypeDef(TypedDict):
    SearchQuery: str,
    AuthenticationToken: NotRequired[str],
    OrganizationId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeNotificationSubscriptionsRequestPaginateTypeDef

# DescribeNotificationSubscriptionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsRequestPaginateTypeDef


def get_value() -> DescribeNotificationSubscriptionsRequestPaginateTypeDef:
    return {
        "OrganizationId": ...,
    }


# DescribeNotificationSubscriptionsRequestPaginateTypeDef definition

class DescribeNotificationSubscriptionsRequestPaginateTypeDef(TypedDict):
    OrganizationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeResourcePermissionsRequestPaginateTypeDef

# DescribeResourcePermissionsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsRequestPaginateTypeDef


def get_value() -> DescribeResourcePermissionsRequestPaginateTypeDef:
    return {
        "ResourceId": ...,
    }


# DescribeResourcePermissionsRequestPaginateTypeDef definition

class DescribeResourcePermissionsRequestPaginateTypeDef(TypedDict):
    ResourceId: str,
    AuthenticationToken: NotRequired[str],
    PrincipalId: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeRootFoldersRequestPaginateTypeDef

# DescribeRootFoldersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeRootFoldersRequestPaginateTypeDef


def get_value() -> DescribeRootFoldersRequestPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# DescribeRootFoldersRequestPaginateTypeDef definition

class DescribeRootFoldersRequestPaginateTypeDef(TypedDict):
    AuthenticationToken: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeUsersRequestPaginateTypeDef

# DescribeUsersRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeUsersRequestPaginateTypeDef


def get_value() -> DescribeUsersRequestPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# DescribeUsersRequestPaginateTypeDef definition

class DescribeUsersRequestPaginateTypeDef(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

# DescribeDocumentVersionsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsResponseTypeDef


def get_value() -> DescribeDocumentVersionsResponseTypeDef:
    return {
        "DocumentVersions": ...,
    }


# DescribeDocumentVersionsResponseTypeDef definition

class DescribeDocumentVersionsResponseTypeDef(TypedDict):
    DocumentVersions: List[DocumentVersionMetadataTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[DocumentVersionMetadataTypeDef]
2. See ResponseMetadataTypeDef

DocumentMetadataTypeDef

# DocumentMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DocumentMetadataTypeDef


def get_value() -> DocumentMetadataTypeDef:
    return {
        "Id": ...,
    }


# DocumentMetadataTypeDef definition

class DocumentMetadataTypeDef(TypedDict):
    Id: NotRequired[str],
    CreatorId: NotRequired[str],
    ParentFolderId: NotRequired[str],
    CreatedTimestamp: NotRequired[datetime.datetime],
    ModifiedTimestamp: NotRequired[datetime.datetime],
    LatestVersionMetadata: NotRequired[DocumentVersionMetadataTypeDef],  # (1)
    ResourceState: NotRequired[ResourceStateTypeType],  # (2)
    Labels: NotRequired[List[str]],

1. See DocumentVersionMetadataTypeDef
2. See ResourceStateTypeType

GetDocumentVersionResponseTypeDef

# GetDocumentVersionResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetDocumentVersionResponseTypeDef


def get_value() -> GetDocumentVersionResponseTypeDef:
    return {
        "Metadata": ...,
    }


# GetDocumentVersionResponseTypeDef definition

class GetDocumentVersionResponseTypeDef(TypedDict):
    Metadata: DocumentVersionMetadataTypeDef,  # (1)
    CustomMetadata: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DocumentVersionMetadataTypeDef
2. See ResponseMetadataTypeDef

DescribeGroupsResponseTypeDef

# DescribeGroupsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeGroupsResponseTypeDef


def get_value() -> DescribeGroupsResponseTypeDef:
    return {
        "Groups": ...,
    }


# DescribeGroupsResponseTypeDef definition

class DescribeGroupsResponseTypeDef(TypedDict):
    Groups: List[GroupMetadataTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[GroupMetadataTypeDef]
2. See ResponseMetadataTypeDef

ParticipantsTypeDef

# ParticipantsTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ParticipantsTypeDef


def get_value() -> ParticipantsTypeDef:
    return {
        "Users": ...,
    }


# ParticipantsTypeDef definition

class ParticipantsTypeDef(TypedDict):
    Users: NotRequired[List[UserMetadataTypeDef]],  # (1)
    Groups: NotRequired[List[GroupMetadataTypeDef]],  # (2)

1. See List[UserMetadataTypeDef]
2. See List[GroupMetadataTypeDef]

PrincipalTypeDef

# PrincipalTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import PrincipalTypeDef


def get_value() -> PrincipalTypeDef:
    return {
        "Id": ...,
    }


# PrincipalTypeDef definition

class PrincipalTypeDef(TypedDict):
    Id: NotRequired[str],
    Type: NotRequired[PrincipalTypeType],  # (1)
    Roles: NotRequired[List[PermissionInfoTypeDef]],  # (2)

1. See PrincipalTypeType
2. See List[PermissionInfoTypeDef]

ResourcePathTypeDef

# ResourcePathTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ResourcePathTypeDef


def get_value() -> ResourcePathTypeDef:
    return {
        "Components": ...,
    }


# ResourcePathTypeDef definition

class ResourcePathTypeDef(TypedDict):
    Components: NotRequired[List[ResourcePathComponentTypeDef]],  # (1)

1. See List[ResourcePathComponentTypeDef]

UserTypeDef

# UserTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UserTypeDef


def get_value() -> UserTypeDef:
    return {
        "Id": ...,
    }


# UserTypeDef 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.datetime],
    ModifiedTimestamp: NotRequired[datetime.datetime],
    TimeZoneId: NotRequired[str],
    Locale: NotRequired[LocaleTypeType],  # (3)
    Storage: NotRequired[UserStorageMetadataTypeDef],  # (4)

1. See UserStatusTypeType
2. See UserTypeType
3. See LocaleTypeType
4. See UserStorageMetadataTypeDef

FiltersTypeDef

# FiltersTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import FiltersTypeDef


def get_value() -> FiltersTypeDef:
    return {
        "TextLocales": ...,
    }


# FiltersTypeDef definition

class FiltersTypeDef(TypedDict):
    TextLocales: NotRequired[Sequence[LanguageCodeTypeType]],  # (1)
    ContentCategories: NotRequired[Sequence[ContentCategoryTypeType]],  # (2)
    ResourceTypes: NotRequired[Sequence[SearchResourceTypeType]],  # (3)
    Labels: NotRequired[Sequence[str]],
    Principals: NotRequired[Sequence[SearchPrincipalTypeTypeDef]],  # (4)
    AncestorIds: NotRequired[Sequence[str]],
    SearchCollectionTypes: NotRequired[Sequence[SearchCollectionTypeType]],  # (5)
    SizeRange: NotRequired[LongRangeTypeTypeDef],  # (6)
    CreatedRange: NotRequired[DateRangeTypeTypeDef],  # (7)
    ModifiedRange: NotRequired[DateRangeTypeTypeDef],  # (7)

1. See Sequence[LanguageCodeTypeType]
2. See Sequence[ContentCategoryTypeType]
3. See Sequence[SearchResourceTypeType]
4. See Sequence[SearchPrincipalTypeTypeDef]
5. See Sequence[SearchCollectionTypeType]
6. See LongRangeTypeTypeDef
7. See DateRangeTypeTypeDef
8. See DateRangeTypeTypeDef

DescribeFolderContentsResponseTypeDef

# DescribeFolderContentsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeFolderContentsResponseTypeDef


def get_value() -> DescribeFolderContentsResponseTypeDef:
    return {
        "Folders": ...,
    }


# DescribeFolderContentsResponseTypeDef definition

class DescribeFolderContentsResponseTypeDef(TypedDict):
    Folders: List[FolderMetadataTypeDef],  # (1)
    Documents: List[DocumentMetadataTypeDef],  # (2)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[FolderMetadataTypeDef]
2. See List[DocumentMetadataTypeDef]
3. See ResponseMetadataTypeDef

GetDocumentResponseTypeDef

# GetDocumentResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetDocumentResponseTypeDef


def get_value() -> GetDocumentResponseTypeDef:
    return {
        "Metadata": ...,
    }


# GetDocumentResponseTypeDef definition

class GetDocumentResponseTypeDef(TypedDict):
    Metadata: DocumentMetadataTypeDef,  # (1)
    CustomMetadata: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DocumentMetadataTypeDef
2. See ResponseMetadataTypeDef

GetResourcesResponseTypeDef

# GetResourcesResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetResourcesResponseTypeDef


def get_value() -> GetResourcesResponseTypeDef:
    return {
        "Folders": ...,
    }


# GetResourcesResponseTypeDef definition

class GetResourcesResponseTypeDef(TypedDict):
    Folders: List[FolderMetadataTypeDef],  # (1)
    Documents: List[DocumentMetadataTypeDef],  # (2)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See List[FolderMetadataTypeDef]
2. See List[DocumentMetadataTypeDef]
3. See ResponseMetadataTypeDef

InitiateDocumentVersionUploadResponseTypeDef

# InitiateDocumentVersionUploadResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import InitiateDocumentVersionUploadResponseTypeDef


def get_value() -> InitiateDocumentVersionUploadResponseTypeDef:
    return {
        "Metadata": ...,
    }


# InitiateDocumentVersionUploadResponseTypeDef definition

class InitiateDocumentVersionUploadResponseTypeDef(TypedDict):
    Metadata: DocumentMetadataTypeDef,  # (1)
    UploadMetadata: UploadMetadataTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See DocumentMetadataTypeDef
2. See UploadMetadataTypeDef
3. See ResponseMetadataTypeDef

DescribeResourcePermissionsResponseTypeDef

# DescribeResourcePermissionsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsResponseTypeDef


def get_value() -> DescribeResourcePermissionsResponseTypeDef:
    return {
        "Principals": ...,
    }


# DescribeResourcePermissionsResponseTypeDef definition

class DescribeResourcePermissionsResponseTypeDef(TypedDict):
    Principals: List[PrincipalTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[PrincipalTypeDef]
2. See ResponseMetadataTypeDef

GetDocumentPathResponseTypeDef

# GetDocumentPathResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetDocumentPathResponseTypeDef


def get_value() -> GetDocumentPathResponseTypeDef:
    return {
        "Path": ...,
    }


# GetDocumentPathResponseTypeDef definition

class GetDocumentPathResponseTypeDef(TypedDict):
    Path: ResourcePathTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourcePathTypeDef
2. See ResponseMetadataTypeDef

GetFolderPathResponseTypeDef

# GetFolderPathResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetFolderPathResponseTypeDef


def get_value() -> GetFolderPathResponseTypeDef:
    return {
        "Path": ...,
    }


# GetFolderPathResponseTypeDef definition

class GetFolderPathResponseTypeDef(TypedDict):
    Path: ResourcePathTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ResourcePathTypeDef
2. See ResponseMetadataTypeDef

ActivateUserResponseTypeDef

# ActivateUserResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ActivateUserResponseTypeDef


def get_value() -> ActivateUserResponseTypeDef:
    return {
        "User": ...,
    }


# ActivateUserResponseTypeDef definition

class ActivateUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserTypeDef
2. See ResponseMetadataTypeDef

CommentMetadataTypeDef

# CommentMetadataTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CommentMetadataTypeDef


def get_value() -> CommentMetadataTypeDef:
    return {
        "CommentId": ...,
    }


# CommentMetadataTypeDef definition

class CommentMetadataTypeDef(TypedDict):
    CommentId: NotRequired[str],
    Contributor: NotRequired[UserTypeDef],  # (1)
    CreatedTimestamp: NotRequired[datetime.datetime],
    CommentStatus: NotRequired[CommentStatusTypeType],  # (2)
    RecipientId: NotRequired[str],
    ContributorId: NotRequired[str],

1. See UserTypeDef
2. See CommentStatusTypeType

CommentTypeDef

# CommentTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CommentTypeDef


def get_value() -> CommentTypeDef:
    return {
        "CommentId": ...,
    }


# CommentTypeDef definition

class CommentTypeDef(TypedDict):
    CommentId: str,
    ParentId: NotRequired[str],
    ThreadId: NotRequired[str],
    Text: NotRequired[str],
    Contributor: NotRequired[UserTypeDef],  # (1)
    CreatedTimestamp: NotRequired[datetime.datetime],
    Status: NotRequired[CommentStatusTypeType],  # (2)
    Visibility: NotRequired[CommentVisibilityTypeType],  # (3)
    RecipientId: NotRequired[str],

1. See UserTypeDef
2. See CommentStatusTypeType
3. See CommentVisibilityTypeType

CreateUserResponseTypeDef

# CreateUserResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateUserResponseTypeDef


def get_value() -> CreateUserResponseTypeDef:
    return {
        "User": ...,
    }


# CreateUserResponseTypeDef definition

class CreateUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserTypeDef
2. See ResponseMetadataTypeDef

DescribeUsersResponseTypeDef

# DescribeUsersResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeUsersResponseTypeDef


def get_value() -> DescribeUsersResponseTypeDef:
    return {
        "Users": ...,
    }


# DescribeUsersResponseTypeDef definition

class DescribeUsersResponseTypeDef(TypedDict):
    Users: List[UserTypeDef],  # (1)
    TotalNumberOfUsers: int,
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[UserTypeDef]
2. See ResponseMetadataTypeDef

GetCurrentUserResponseTypeDef

# GetCurrentUserResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import GetCurrentUserResponseTypeDef


def get_value() -> GetCurrentUserResponseTypeDef:
    return {
        "User": ...,
    }


# GetCurrentUserResponseTypeDef definition

class GetCurrentUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserTypeDef
2. See ResponseMetadataTypeDef

UpdateUserResponseTypeDef

# UpdateUserResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import UpdateUserResponseTypeDef


def get_value() -> UpdateUserResponseTypeDef:
    return {
        "User": ...,
    }


# UpdateUserResponseTypeDef definition

class UpdateUserResponseTypeDef(TypedDict):
    User: UserTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See UserTypeDef
2. See ResponseMetadataTypeDef

SearchResourcesRequestPaginateTypeDef

# SearchResourcesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SearchResourcesRequestPaginateTypeDef


def get_value() -> SearchResourcesRequestPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# SearchResourcesRequestPaginateTypeDef definition

class SearchResourcesRequestPaginateTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    QueryText: NotRequired[str],
    QueryScopes: NotRequired[Sequence[SearchQueryScopeTypeType]],  # (1)
    OrganizationId: NotRequired[str],
    AdditionalResponseFields: NotRequired[Sequence[AdditionalResponseFieldTypeType]],  # (2)
    Filters: NotRequired[FiltersTypeDef],  # (3)
    OrderBy: NotRequired[Sequence[SearchSortResultTypeDef]],  # (4)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (5)

1. See Sequence[SearchQueryScopeTypeType]
2. See Sequence[Literal['WEBURL']]
3. See FiltersTypeDef
4. See Sequence[SearchSortResultTypeDef]
5. See PaginatorConfigTypeDef

SearchResourcesRequestTypeDef

# SearchResourcesRequestTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SearchResourcesRequestTypeDef


def get_value() -> SearchResourcesRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }


# SearchResourcesRequestTypeDef definition

class SearchResourcesRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    QueryText: NotRequired[str],
    QueryScopes: NotRequired[Sequence[SearchQueryScopeTypeType]],  # (1)
    OrganizationId: NotRequired[str],
    AdditionalResponseFields: NotRequired[Sequence[AdditionalResponseFieldTypeType]],  # (2)
    Filters: NotRequired[FiltersTypeDef],  # (3)
    OrderBy: NotRequired[Sequence[SearchSortResultTypeDef]],  # (4)
    Limit: NotRequired[int],
    Marker: NotRequired[str],

1. See Sequence[SearchQueryScopeTypeType]
2. See Sequence[Literal['WEBURL']]
3. See FiltersTypeDef
4. See Sequence[SearchSortResultTypeDef]

ActivityTypeDef

# ActivityTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ActivityTypeDef


def get_value() -> ActivityTypeDef:
    return {
        "Type": ...,
    }


# ActivityTypeDef definition

class ActivityTypeDef(TypedDict):
    Type: NotRequired[ActivityTypeType],  # (1)
    TimeStamp: NotRequired[datetime.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

ResponseItemTypeDef

# ResponseItemTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import ResponseItemTypeDef


def get_value() -> ResponseItemTypeDef:
    return {
        "ResourceType": ...,
    }


# ResponseItemTypeDef definition

class ResponseItemTypeDef(TypedDict):
    ResourceType: NotRequired[ResponseItemTypeType],  # (1)
    WebUrl: NotRequired[str],
    DocumentMetadata: NotRequired[DocumentMetadataTypeDef],  # (2)
    FolderMetadata: NotRequired[FolderMetadataTypeDef],  # (3)
    CommentMetadata: NotRequired[CommentMetadataTypeDef],  # (4)
    DocumentVersionMetadata: NotRequired[DocumentVersionMetadataTypeDef],  # (5)

1. See ResponseItemTypeType
2. See DocumentMetadataTypeDef
3. See FolderMetadataTypeDef
4. See CommentMetadataTypeDef
5. See DocumentVersionMetadataTypeDef

CreateCommentResponseTypeDef

# CreateCommentResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import CreateCommentResponseTypeDef


def get_value() -> CreateCommentResponseTypeDef:
    return {
        "Comment": ...,
    }


# CreateCommentResponseTypeDef definition

class CreateCommentResponseTypeDef(TypedDict):
    Comment: CommentTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See CommentTypeDef
2. See ResponseMetadataTypeDef

DescribeCommentsResponseTypeDef

# DescribeCommentsResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeCommentsResponseTypeDef


def get_value() -> DescribeCommentsResponseTypeDef:
    return {
        "Comments": ...,
    }


# DescribeCommentsResponseTypeDef definition

class DescribeCommentsResponseTypeDef(TypedDict):
    Comments: List[CommentTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[CommentTypeDef]
2. See ResponseMetadataTypeDef

DescribeActivitiesResponseTypeDef

# DescribeActivitiesResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import DescribeActivitiesResponseTypeDef


def get_value() -> DescribeActivitiesResponseTypeDef:
    return {
        "UserActivities": ...,
    }


# DescribeActivitiesResponseTypeDef definition

class DescribeActivitiesResponseTypeDef(TypedDict):
    UserActivities: List[ActivityTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[ActivityTypeDef]
2. See ResponseMetadataTypeDef

SearchResourcesResponseTypeDef

# SearchResourcesResponseTypeDef TypedDict usage example

from mypy_boto3_workdocs.type_defs import SearchResourcesResponseTypeDef


def get_value() -> SearchResourcesResponseTypeDef:
    return {
        "Items": ...,
    }


# SearchResourcesResponseTypeDef definition

class SearchResourcesResponseTypeDef(TypedDict):
    Items: List[ResponseItemTypeDef],  # (1)
    Marker: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See List[ResponseItemTypeDef]
2. See ResponseMetadataTypeDef