Skip to content

Typed dictionaries

Index > WorkDocs > Typed dictionaries

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

AbortDocumentVersionUploadRequestRequestTypeDef

# AbortDocumentVersionUploadRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import AbortDocumentVersionUploadRequestRequestTypeDef

def get_value() -> AbortDocumentVersionUploadRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
# AbortDocumentVersionUploadRequestRequestTypeDef definition

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

ActivateUserRequestRequestTypeDef

# ActivateUserRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import ActivateUserRequestRequestTypeDef

def get_value() -> ActivateUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
# ActivateUserRequestRequestTypeDef definition

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

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_workdocs.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

UserMetadataTypeDef

# UserMetadataTypeDef 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 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 usage example

from mypy_boto3_workdocs.type_defs import SharePrincipalTypeDef

def get_value() -> SharePrincipalTypeDef:
    return {
        "Id": ...,
        "Type": ...,
        "Role": ...,
    }
# SharePrincipalTypeDef definition

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

ShareResultTypeDef

# ShareResultTypeDef 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

CreateCommentRequestRequestTypeDef

# CreateCommentRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateCommentRequestRequestTypeDef

def get_value() -> CreateCommentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
        "Text": ...,
    }
# CreateCommentRequestRequestTypeDef definition

class CreateCommentRequestRequestTypeDef(TypedDict):
    DocumentId: str,
    VersionId: str,
    Text: str,
    AuthenticationToken: NotRequired[str],
    ParentId: NotRequired[str],
    ThreadId: NotRequired[str],
    Visibility: NotRequired[CommentVisibilityTypeType],  # (1)
    NotifyCollaborators: NotRequired[bool],
  1. See CommentVisibilityTypeType

CreateCustomMetadataRequestRequestTypeDef

# CreateCustomMetadataRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateCustomMetadataRequestRequestTypeDef

def get_value() -> CreateCustomMetadataRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "CustomMetadata": ...,
    }
# CreateCustomMetadataRequestRequestTypeDef definition

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

CreateFolderRequestRequestTypeDef

# CreateFolderRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateFolderRequestRequestTypeDef

def get_value() -> CreateFolderRequestRequestTypeDef:
    return {
        "ParentFolderId": ...,
    }
# CreateFolderRequestRequestTypeDef definition

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

FolderMetadataTypeDef

# FolderMetadataTypeDef 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],
    ModifiedTimestamp: NotRequired[datetime],
    ResourceState: NotRequired[ResourceStateTypeType],  # (1)
    Signature: NotRequired[str],
    Labels: NotRequired[List[str]],
    Size: NotRequired[int],
    LatestVersionSize: NotRequired[int],
  1. See ResourceStateTypeType

CreateLabelsRequestRequestTypeDef

# CreateLabelsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateLabelsRequestRequestTypeDef

def get_value() -> CreateLabelsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "Labels": ...,
    }
# CreateLabelsRequestRequestTypeDef definition

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

CreateNotificationSubscriptionRequestRequestTypeDef

# CreateNotificationSubscriptionRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateNotificationSubscriptionRequestRequestTypeDef

def get_value() -> CreateNotificationSubscriptionRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
        "Endpoint": ...,
        "Protocol": ...,
        "SubscriptionType": ...,
    }
# CreateNotificationSubscriptionRequestRequestTypeDef definition

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

SubscriptionTypeDef

# SubscriptionTypeDef 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 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

DeactivateUserRequestRequestTypeDef

# DeactivateUserRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeactivateUserRequestRequestTypeDef

def get_value() -> DeactivateUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
# DeactivateUserRequestRequestTypeDef definition

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

DeleteCommentRequestRequestTypeDef

# DeleteCommentRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteCommentRequestRequestTypeDef

def get_value() -> DeleteCommentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
        "CommentId": ...,
    }
# DeleteCommentRequestRequestTypeDef definition

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

DeleteCustomMetadataRequestRequestTypeDef

# DeleteCustomMetadataRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteCustomMetadataRequestRequestTypeDef

def get_value() -> DeleteCustomMetadataRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
# DeleteCustomMetadataRequestRequestTypeDef definition

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

DeleteDocumentRequestRequestTypeDef

# DeleteDocumentRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteDocumentRequestRequestTypeDef

def get_value() -> DeleteDocumentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
# DeleteDocumentRequestRequestTypeDef definition

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

DeleteDocumentVersionRequestRequestTypeDef

# DeleteDocumentVersionRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteDocumentVersionRequestRequestTypeDef

def get_value() -> DeleteDocumentVersionRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
        "DeletePriorVersions": ...,
    }
# DeleteDocumentVersionRequestRequestTypeDef definition

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

DeleteFolderContentsRequestRequestTypeDef

# DeleteFolderContentsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteFolderContentsRequestRequestTypeDef

def get_value() -> DeleteFolderContentsRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
# DeleteFolderContentsRequestRequestTypeDef definition

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

DeleteFolderRequestRequestTypeDef

# DeleteFolderRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteFolderRequestRequestTypeDef

def get_value() -> DeleteFolderRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
# DeleteFolderRequestRequestTypeDef definition

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

DeleteLabelsRequestRequestTypeDef

# DeleteLabelsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteLabelsRequestRequestTypeDef

def get_value() -> DeleteLabelsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
# DeleteLabelsRequestRequestTypeDef definition

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

DeleteNotificationSubscriptionRequestRequestTypeDef

# DeleteNotificationSubscriptionRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteNotificationSubscriptionRequestRequestTypeDef

def get_value() -> DeleteNotificationSubscriptionRequestRequestTypeDef:
    return {
        "SubscriptionId": ...,
        "OrganizationId": ...,
    }
# DeleteNotificationSubscriptionRequestRequestTypeDef definition

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

DeleteUserRequestRequestTypeDef

# DeleteUserRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DeleteUserRequestRequestTypeDef

def get_value() -> DeleteUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
# DeleteUserRequestRequestTypeDef definition

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

PaginatorConfigTypeDef

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

DescribeActivitiesRequestRequestTypeDef

# DescribeActivitiesRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeActivitiesRequestRequestTypeDef

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

# DescribeCommentsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeCommentsRequestRequestTypeDef

def get_value() -> DescribeCommentsRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
# DescribeCommentsRequestRequestTypeDef definition

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

DescribeDocumentVersionsRequestRequestTypeDef

# DescribeDocumentVersionsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsRequestRequestTypeDef

def get_value() -> DescribeDocumentVersionsRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
# DescribeDocumentVersionsRequestRequestTypeDef definition

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

DocumentVersionMetadataTypeDef

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

DescribeFolderContentsRequestRequestTypeDef

# DescribeFolderContentsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeFolderContentsRequestRequestTypeDef

def get_value() -> DescribeFolderContentsRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
# DescribeFolderContentsRequestRequestTypeDef definition

class DescribeFolderContentsRequestRequestTypeDef(TypedDict):
    FolderId: str,
    AuthenticationToken: NotRequired[str],
    Sort: NotRequired[ResourceSortTypeType],  # (1)
    Order: NotRequired[OrderTypeType],  # (2)
    Limit: NotRequired[int],
    Marker: NotRequired[str],
    Type: NotRequired[FolderContentTypeType],  # (3)
    Include: NotRequired[str],
  1. See ResourceSortTypeType
  2. See OrderTypeType
  3. See FolderContentTypeType

DescribeGroupsRequestRequestTypeDef

# DescribeGroupsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeGroupsRequestRequestTypeDef

def get_value() -> DescribeGroupsRequestRequestTypeDef:
    return {
        "SearchQuery": ...,
    }
# DescribeGroupsRequestRequestTypeDef definition

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

GroupMetadataTypeDef

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

DescribeNotificationSubscriptionsRequestRequestTypeDef

# DescribeNotificationSubscriptionsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsRequestRequestTypeDef

def get_value() -> DescribeNotificationSubscriptionsRequestRequestTypeDef:
    return {
        "OrganizationId": ...,
    }
# DescribeNotificationSubscriptionsRequestRequestTypeDef definition

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

DescribeResourcePermissionsRequestRequestTypeDef

# DescribeResourcePermissionsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsRequestRequestTypeDef

def get_value() -> DescribeResourcePermissionsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
# DescribeResourcePermissionsRequestRequestTypeDef definition

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

DescribeRootFoldersRequestRequestTypeDef

# DescribeRootFoldersRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeRootFoldersRequestRequestTypeDef

def get_value() -> DescribeRootFoldersRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
# DescribeRootFoldersRequestRequestTypeDef definition

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

DescribeUsersRequestRequestTypeDef

# DescribeUsersRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeUsersRequestRequestTypeDef

def get_value() -> DescribeUsersRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
# DescribeUsersRequestRequestTypeDef definition

class DescribeUsersRequestRequestTypeDef(TypedDict):
    AuthenticationToken: NotRequired[str],
    OrganizationId: NotRequired[str],
    UserIds: NotRequired[str],
    Query: NotRequired[str],
    Include: NotRequired[UserFilterTypeType],  # (1)
    Order: NotRequired[OrderTypeType],  # (2)
    Sort: NotRequired[UserSortTypeType],  # (3)
    Marker: NotRequired[str],
    Limit: NotRequired[int],
    Fields: NotRequired[str],
  1. See UserFilterTypeType
  2. See OrderTypeType
  3. See UserSortTypeType

GetCurrentUserRequestRequestTypeDef

# GetCurrentUserRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetCurrentUserRequestRequestTypeDef

def get_value() -> GetCurrentUserRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
# GetCurrentUserRequestRequestTypeDef definition

class GetCurrentUserRequestRequestTypeDef(TypedDict):
    AuthenticationToken: str,

GetDocumentPathRequestRequestTypeDef

# GetDocumentPathRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetDocumentPathRequestRequestTypeDef

def get_value() -> GetDocumentPathRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
# GetDocumentPathRequestRequestTypeDef definition

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

GetDocumentRequestRequestTypeDef

# GetDocumentRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetDocumentRequestRequestTypeDef

def get_value() -> GetDocumentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
# GetDocumentRequestRequestTypeDef definition

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

GetDocumentVersionRequestRequestTypeDef

# GetDocumentVersionRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetDocumentVersionRequestRequestTypeDef

def get_value() -> GetDocumentVersionRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
# GetDocumentVersionRequestRequestTypeDef definition

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

GetFolderPathRequestRequestTypeDef

# GetFolderPathRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetFolderPathRequestRequestTypeDef

def get_value() -> GetFolderPathRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
# GetFolderPathRequestRequestTypeDef definition

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

GetFolderRequestRequestTypeDef

# GetFolderRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetFolderRequestRequestTypeDef

def get_value() -> GetFolderRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
# GetFolderRequestRequestTypeDef definition

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

GetResourcesRequestRequestTypeDef

# GetResourcesRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetResourcesRequestRequestTypeDef

def get_value() -> GetResourcesRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
# GetResourcesRequestRequestTypeDef definition

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

InitiateDocumentVersionUploadRequestRequestTypeDef

# InitiateDocumentVersionUploadRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import InitiateDocumentVersionUploadRequestRequestTypeDef

def get_value() -> InitiateDocumentVersionUploadRequestRequestTypeDef:
    return {
        "AuthenticationToken": ...,
    }
# InitiateDocumentVersionUploadRequestRequestTypeDef definition

class InitiateDocumentVersionUploadRequestRequestTypeDef(TypedDict):
    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],
    ParentFolderId: NotRequired[str],

UploadMetadataTypeDef

# UploadMetadataTypeDef 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 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

RemoveAllResourcePermissionsRequestRequestTypeDef

# RemoveAllResourcePermissionsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import RemoveAllResourcePermissionsRequestRequestTypeDef

def get_value() -> RemoveAllResourcePermissionsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
    }
# RemoveAllResourcePermissionsRequestRequestTypeDef definition

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

RemoveResourcePermissionRequestRequestTypeDef

# RemoveResourcePermissionRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import RemoveResourcePermissionRequestRequestTypeDef

def get_value() -> RemoveResourcePermissionRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "PrincipalId": ...,
    }
# RemoveResourcePermissionRequestRequestTypeDef definition

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

ResourcePathComponentTypeDef

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

RestoreDocumentVersionsRequestRequestTypeDef

# RestoreDocumentVersionsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import RestoreDocumentVersionsRequestRequestTypeDef

def get_value() -> RestoreDocumentVersionsRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
# RestoreDocumentVersionsRequestRequestTypeDef definition

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

UpdateDocumentRequestRequestTypeDef

# UpdateDocumentRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import UpdateDocumentRequestRequestTypeDef

def get_value() -> UpdateDocumentRequestRequestTypeDef:
    return {
        "DocumentId": ...,
    }
# UpdateDocumentRequestRequestTypeDef definition

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

UpdateDocumentVersionRequestRequestTypeDef

# UpdateDocumentVersionRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import UpdateDocumentVersionRequestRequestTypeDef

def get_value() -> UpdateDocumentVersionRequestRequestTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
# UpdateDocumentVersionRequestRequestTypeDef definition

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

UpdateFolderRequestRequestTypeDef

# UpdateFolderRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import UpdateFolderRequestRequestTypeDef

def get_value() -> UpdateFolderRequestRequestTypeDef:
    return {
        "FolderId": ...,
    }
# UpdateFolderRequestRequestTypeDef definition

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

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef 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 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

AddResourcePermissionsRequestRequestTypeDef

# AddResourcePermissionsRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import AddResourcePermissionsRequestRequestTypeDef

def get_value() -> AddResourcePermissionsRequestRequestTypeDef:
    return {
        "ResourceId": ...,
        "Principals": ...,
    }
# AddResourcePermissionsRequestRequestTypeDef definition

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

AddResourcePermissionsResponseTypeDef

# AddResourcePermissionsResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import AddResourcePermissionsResponseTypeDef

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

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

CreateFolderResponseTypeDef

# CreateFolderResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateFolderResponseTypeDef

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

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

DescribeRootFoldersResponseTypeDef

# DescribeRootFoldersResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeRootFoldersResponseTypeDef

def get_value() -> DescribeRootFoldersResponseTypeDef:
    return {
        "Folders": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeRootFoldersResponseTypeDef definition

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

GetFolderResponseTypeDef

# GetFolderResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetFolderResponseTypeDef

def get_value() -> GetFolderResponseTypeDef:
    return {
        "Metadata": ...,
        "CustomMetadata": ...,
        "ResponseMetadata": ...,
    }
# GetFolderResponseTypeDef definition

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

CreateNotificationSubscriptionResponseTypeDef

# CreateNotificationSubscriptionResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateNotificationSubscriptionResponseTypeDef

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

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

DescribeNotificationSubscriptionsResponseTypeDef

# DescribeNotificationSubscriptionsResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsResponseTypeDef

def get_value() -> DescribeNotificationSubscriptionsResponseTypeDef:
    return {
        "Subscriptions": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeNotificationSubscriptionsResponseTypeDef definition

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

CreateUserRequestRequestTypeDef

# CreateUserRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateUserRequestRequestTypeDef

def get_value() -> CreateUserRequestRequestTypeDef:
    return {
        "Username": ...,
        "GivenName": ...,
        "Surname": ...,
        "Password": ...,
    }
# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    Username: str,
    GivenName: str,
    Surname: str,
    Password: str,
    OrganizationId: NotRequired[str],
    EmailAddress: NotRequired[str],
    TimeZoneId: NotRequired[str],
    StorageRule: NotRequired[StorageRuleTypeTypeDef],  # (1)
    AuthenticationToken: NotRequired[str],
  1. See StorageRuleTypeTypeDef

UpdateUserRequestRequestTypeDef

# UpdateUserRequestRequestTypeDef usage example

from mypy_boto3_workdocs.type_defs import UpdateUserRequestRequestTypeDef

def get_value() -> UpdateUserRequestRequestTypeDef:
    return {
        "UserId": ...,
    }
# UpdateUserRequestRequestTypeDef 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

# UserStorageMetadataTypeDef 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

DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef

# DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeActivitiesRequestDescribeActivitiesPaginateTypeDef

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

# DescribeCommentsRequestDescribeCommentsPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeCommentsRequestDescribeCommentsPaginateTypeDef

def get_value() -> DescribeCommentsRequestDescribeCommentsPaginateTypeDef:
    return {
        "DocumentId": ...,
        "VersionId": ...,
    }
# DescribeCommentsRequestDescribeCommentsPaginateTypeDef definition

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

DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef

# DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef

def get_value() -> DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef:
    return {
        "DocumentId": ...,
    }
# DescribeDocumentVersionsRequestDescribeDocumentVersionsPaginateTypeDef definition

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

DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef

# DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeFolderContentsRequestDescribeFolderContentsPaginateTypeDef

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

# DescribeGroupsRequestDescribeGroupsPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeGroupsRequestDescribeGroupsPaginateTypeDef

def get_value() -> DescribeGroupsRequestDescribeGroupsPaginateTypeDef:
    return {
        "SearchQuery": ...,
    }
# DescribeGroupsRequestDescribeGroupsPaginateTypeDef definition

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

DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef

# DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef

def get_value() -> DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef:
    return {
        "OrganizationId": ...,
    }
# DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef definition

class DescribeNotificationSubscriptionsRequestDescribeNotificationSubscriptionsPaginateTypeDef(TypedDict):
    OrganizationId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef

# DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef

def get_value() -> DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef:
    return {
        "ResourceId": ...,
    }
# DescribeResourcePermissionsRequestDescribeResourcePermissionsPaginateTypeDef definition

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

DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef

# DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef

def get_value() -> DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef:
    return {
        "AuthenticationToken": ...,
    }
# DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef definition

class DescribeRootFoldersRequestDescribeRootFoldersPaginateTypeDef(TypedDict):
    AuthenticationToken: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeUsersRequestDescribeUsersPaginateTypeDef

# DescribeUsersRequestDescribeUsersPaginateTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeUsersRequestDescribeUsersPaginateTypeDef

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

# DescribeDocumentVersionsResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeDocumentVersionsResponseTypeDef

def get_value() -> DescribeDocumentVersionsResponseTypeDef:
    return {
        "DocumentVersions": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeDocumentVersionsResponseTypeDef definition

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

DocumentMetadataTypeDef

# DocumentMetadataTypeDef 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],
    ModifiedTimestamp: NotRequired[datetime],
    LatestVersionMetadata: NotRequired[DocumentVersionMetadataTypeDef],  # (1)
    ResourceState: NotRequired[ResourceStateTypeType],  # (2)
    Labels: NotRequired[List[str]],
  1. See DocumentVersionMetadataTypeDef
  2. See ResourceStateTypeType

GetDocumentVersionResponseTypeDef

# GetDocumentVersionResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetDocumentVersionResponseTypeDef

def get_value() -> GetDocumentVersionResponseTypeDef:
    return {
        "Metadata": ...,
        "CustomMetadata": ...,
        "ResponseMetadata": ...,
    }
# GetDocumentVersionResponseTypeDef definition

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

DescribeGroupsResponseTypeDef

# DescribeGroupsResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeGroupsResponseTypeDef

def get_value() -> DescribeGroupsResponseTypeDef:
    return {
        "Groups": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeGroupsResponseTypeDef definition

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

ParticipantsTypeDef

# ParticipantsTypeDef 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 UserMetadataTypeDef
  2. See GroupMetadataTypeDef

PrincipalTypeDef

# PrincipalTypeDef 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 PermissionInfoTypeDef

ResourcePathTypeDef

# ResourcePathTypeDef 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 ResourcePathComponentTypeDef

UserTypeDef

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

# DescribeFolderContentsResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeFolderContentsResponseTypeDef

def get_value() -> DescribeFolderContentsResponseTypeDef:
    return {
        "Folders": ...,
        "Documents": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeFolderContentsResponseTypeDef 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

# GetDocumentResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetDocumentResponseTypeDef

def get_value() -> GetDocumentResponseTypeDef:
    return {
        "Metadata": ...,
        "CustomMetadata": ...,
        "ResponseMetadata": ...,
    }
# GetDocumentResponseTypeDef definition

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

GetResourcesResponseTypeDef

# GetResourcesResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetResourcesResponseTypeDef

def get_value() -> GetResourcesResponseTypeDef:
    return {
        "Folders": ...,
        "Documents": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# GetResourcesResponseTypeDef 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

# InitiateDocumentVersionUploadResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import InitiateDocumentVersionUploadResponseTypeDef

def get_value() -> InitiateDocumentVersionUploadResponseTypeDef:
    return {
        "Metadata": ...,
        "UploadMetadata": ...,
        "ResponseMetadata": ...,
    }
# 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 usage example

from mypy_boto3_workdocs.type_defs import DescribeResourcePermissionsResponseTypeDef

def get_value() -> DescribeResourcePermissionsResponseTypeDef:
    return {
        "Principals": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeResourcePermissionsResponseTypeDef definition

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

GetDocumentPathResponseTypeDef

# GetDocumentPathResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetDocumentPathResponseTypeDef

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

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

GetFolderPathResponseTypeDef

# GetFolderPathResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetFolderPathResponseTypeDef

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

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

ActivateUserResponseTypeDef

# ActivateUserResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import ActivateUserResponseTypeDef

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

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

CommentMetadataTypeDef

# CommentMetadataTypeDef 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],
    CommentStatus: NotRequired[CommentStatusTypeType],  # (2)
    RecipientId: NotRequired[str],
  1. See UserTypeDef
  2. See CommentStatusTypeType

CommentTypeDef

# CommentTypeDef 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],
    Status: NotRequired[CommentStatusTypeType],  # (2)
    Visibility: NotRequired[CommentVisibilityTypeType],  # (3)
    RecipientId: NotRequired[str],
  1. See UserTypeDef
  2. See CommentStatusTypeType
  3. See CommentVisibilityTypeType

CreateUserResponseTypeDef

# CreateUserResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateUserResponseTypeDef

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

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

DescribeUsersResponseTypeDef

# DescribeUsersResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeUsersResponseTypeDef

def get_value() -> DescribeUsersResponseTypeDef:
    return {
        "Users": ...,
        "TotalNumberOfUsers": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeUsersResponseTypeDef definition

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

GetCurrentUserResponseTypeDef

# GetCurrentUserResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import GetCurrentUserResponseTypeDef

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

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

UpdateUserResponseTypeDef

# UpdateUserResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import UpdateUserResponseTypeDef

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

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

ActivityTypeDef

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

# CreateCommentResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import CreateCommentResponseTypeDef

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

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

DescribeCommentsResponseTypeDef

# DescribeCommentsResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeCommentsResponseTypeDef

def get_value() -> DescribeCommentsResponseTypeDef:
    return {
        "Comments": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeCommentsResponseTypeDef definition

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

DescribeActivitiesResponseTypeDef

# DescribeActivitiesResponseTypeDef usage example

from mypy_boto3_workdocs.type_defs import DescribeActivitiesResponseTypeDef

def get_value() -> DescribeActivitiesResponseTypeDef:
    return {
        "UserActivities": ...,
        "Marker": ...,
        "ResponseMetadata": ...,
    }
# DescribeActivitiesResponseTypeDef definition

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