Literals#
Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.
ActivityTypeType#
# ActivityTypeType usage example
from mypy_boto3_workdocs.literals import ActivityTypeType
def get_value() -> ActivityTypeType:
return "DOCUMENT_ANNOTATION_ADDED"# ActivityTypeType definition
ActivityTypeType = Literal[
"DOCUMENT_ANNOTATION_ADDED",
"DOCUMENT_ANNOTATION_DELETED",
"DOCUMENT_CHECKED_IN",
"DOCUMENT_CHECKED_OUT",
"DOCUMENT_COMMENT_ADDED",
"DOCUMENT_COMMENT_DELETED",
"DOCUMENT_MOVED",
"DOCUMENT_RECYCLED",
"DOCUMENT_RENAMED",
"DOCUMENT_RESTORED",
"DOCUMENT_REVERTED",
"DOCUMENT_SHARE_PERMISSION_CHANGED",
"DOCUMENT_SHAREABLE_LINK_CREATED",
"DOCUMENT_SHAREABLE_LINK_PERMISSION_CHANGED",
"DOCUMENT_SHAREABLE_LINK_REMOVED",
"DOCUMENT_SHARED",
"DOCUMENT_UNSHARED",
"DOCUMENT_VERSION_DELETED",
"DOCUMENT_VERSION_DOWNLOADED",
"DOCUMENT_VERSION_UPLOADED",
"DOCUMENT_VERSION_VIEWED",
"FOLDER_CREATED",
"FOLDER_DELETED",
"FOLDER_MOVED",
"FOLDER_RECYCLED",
"FOLDER_RENAMED",
"FOLDER_RESTORED",
"FOLDER_SHARE_PERMISSION_CHANGED",
"FOLDER_SHAREABLE_LINK_CREATED",
"FOLDER_SHAREABLE_LINK_PERMISSION_CHANGED",
"FOLDER_SHAREABLE_LINK_REMOVED",
"FOLDER_SHARED",
"FOLDER_UNSHARED",
]AdditionalResponseFieldTypeType#
# AdditionalResponseFieldTypeType usage example
from mypy_boto3_workdocs.literals import AdditionalResponseFieldTypeType
def get_value() -> AdditionalResponseFieldTypeType:
return "WEBURL"# AdditionalResponseFieldTypeType definition
AdditionalResponseFieldTypeType = Literal[
"WEBURL",
]BooleanEnumTypeType#
# BooleanEnumTypeType usage example
from mypy_boto3_workdocs.literals import BooleanEnumTypeType
def get_value() -> BooleanEnumTypeType:
return "FALSE"# BooleanEnumTypeType definition
BooleanEnumTypeType = Literal[
"FALSE",
"TRUE",
]CommentStatusTypeType#
# CommentStatusTypeType usage example
from mypy_boto3_workdocs.literals import CommentStatusTypeType
def get_value() -> CommentStatusTypeType:
return "DELETED"# CommentStatusTypeType definition
CommentStatusTypeType = Literal[
"DELETED",
"DRAFT",
"PUBLISHED",
]CommentVisibilityTypeType#
# CommentVisibilityTypeType usage example
from mypy_boto3_workdocs.literals import CommentVisibilityTypeType
def get_value() -> CommentVisibilityTypeType:
return "PRIVATE"# CommentVisibilityTypeType definition
CommentVisibilityTypeType = Literal[
"PRIVATE",
"PUBLIC",
]ContentCategoryTypeType#
# ContentCategoryTypeType usage example
from mypy_boto3_workdocs.literals import ContentCategoryTypeType
def get_value() -> ContentCategoryTypeType:
return "AUDIO"# ContentCategoryTypeType definition
ContentCategoryTypeType = Literal[
"AUDIO",
"DOCUMENT",
"IMAGE",
"OTHER",
"PDF",
"PRESENTATION",
"SOURCE_CODE",
"SPREADSHEET",
"VIDEO",
]DescribeActivitiesPaginatorName#
# DescribeActivitiesPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeActivitiesPaginatorName
def get_value() -> DescribeActivitiesPaginatorName:
return "describe_activities"# DescribeActivitiesPaginatorName definition
DescribeActivitiesPaginatorName = Literal[
"describe_activities",
]DescribeCommentsPaginatorName#
# DescribeCommentsPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeCommentsPaginatorName
def get_value() -> DescribeCommentsPaginatorName:
return "describe_comments"# DescribeCommentsPaginatorName definition
DescribeCommentsPaginatorName = Literal[
"describe_comments",
]DescribeDocumentVersionsPaginatorName#
# DescribeDocumentVersionsPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeDocumentVersionsPaginatorName
def get_value() -> DescribeDocumentVersionsPaginatorName:
return "describe_document_versions"# DescribeDocumentVersionsPaginatorName definition
DescribeDocumentVersionsPaginatorName = Literal[
"describe_document_versions",
]DescribeFolderContentsPaginatorName#
# DescribeFolderContentsPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeFolderContentsPaginatorName
def get_value() -> DescribeFolderContentsPaginatorName:
return "describe_folder_contents"# DescribeFolderContentsPaginatorName definition
DescribeFolderContentsPaginatorName = Literal[
"describe_folder_contents",
]DescribeGroupsPaginatorName#
# DescribeGroupsPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeGroupsPaginatorName
def get_value() -> DescribeGroupsPaginatorName:
return "describe_groups"# DescribeGroupsPaginatorName definition
DescribeGroupsPaginatorName = Literal[
"describe_groups",
]DescribeNotificationSubscriptionsPaginatorName#
# DescribeNotificationSubscriptionsPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeNotificationSubscriptionsPaginatorName
def get_value() -> DescribeNotificationSubscriptionsPaginatorName:
return "describe_notification_subscriptions"# DescribeNotificationSubscriptionsPaginatorName definition
DescribeNotificationSubscriptionsPaginatorName = Literal[
"describe_notification_subscriptions",
]DescribeResourcePermissionsPaginatorName#
# DescribeResourcePermissionsPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeResourcePermissionsPaginatorName
def get_value() -> DescribeResourcePermissionsPaginatorName:
return "describe_resource_permissions"# DescribeResourcePermissionsPaginatorName definition
DescribeResourcePermissionsPaginatorName = Literal[
"describe_resource_permissions",
]DescribeRootFoldersPaginatorName#
# DescribeRootFoldersPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeRootFoldersPaginatorName
def get_value() -> DescribeRootFoldersPaginatorName:
return "describe_root_folders"# DescribeRootFoldersPaginatorName definition
DescribeRootFoldersPaginatorName = Literal[
"describe_root_folders",
]DescribeUsersPaginatorName#
# DescribeUsersPaginatorName usage example
from mypy_boto3_workdocs.literals import DescribeUsersPaginatorName
def get_value() -> DescribeUsersPaginatorName:
return "describe_users"# DescribeUsersPaginatorName definition
DescribeUsersPaginatorName = Literal[
"describe_users",
]DocumentSourceTypeType#
# DocumentSourceTypeType usage example
from mypy_boto3_workdocs.literals import DocumentSourceTypeType
def get_value() -> DocumentSourceTypeType:
return "ORIGINAL"# DocumentSourceTypeType definition
DocumentSourceTypeType = Literal[
"ORIGINAL",
"WITH_COMMENTS",
]DocumentStatusTypeType#
# DocumentStatusTypeType usage example
from mypy_boto3_workdocs.literals import DocumentStatusTypeType
def get_value() -> DocumentStatusTypeType:
return "ACTIVE"# DocumentStatusTypeType definition
DocumentStatusTypeType = Literal[
"ACTIVE",
"INITIALIZED",
]DocumentThumbnailTypeType#
# DocumentThumbnailTypeType usage example
from mypy_boto3_workdocs.literals import DocumentThumbnailTypeType
def get_value() -> DocumentThumbnailTypeType:
return "LARGE"# DocumentThumbnailTypeType definition
DocumentThumbnailTypeType = Literal[
"LARGE",
"SMALL",
"SMALL_HQ",
]DocumentVersionStatusType#
# DocumentVersionStatusType usage example
from mypy_boto3_workdocs.literals import DocumentVersionStatusType
def get_value() -> DocumentVersionStatusType:
return "ACTIVE"# DocumentVersionStatusType definition
DocumentVersionStatusType = Literal[
"ACTIVE",
]FolderContentTypeType#
# FolderContentTypeType usage example
from mypy_boto3_workdocs.literals import FolderContentTypeType
def get_value() -> FolderContentTypeType:
return "ALL"# FolderContentTypeType definition
FolderContentTypeType = Literal[
"ALL",
"DOCUMENT",
"FOLDER",
]LanguageCodeTypeType#
# LanguageCodeTypeType usage example
from mypy_boto3_workdocs.literals import LanguageCodeTypeType
def get_value() -> LanguageCodeTypeType:
return "AR"# LanguageCodeTypeType definition
LanguageCodeTypeType = Literal[
"AR",
"BG",
"BN",
"CS",
"DA",
"DE",
"DEFAULT",
"EL",
"EN",
"ES",
"FA",
"FI",
"FR",
"HI",
"HU",
"ID",
"IT",
"JA",
"KO",
"LT",
"LV",
"NL",
"NO",
"PT",
"RO",
"RU",
"SV",
"SW",
"TH",
"TR",
"ZH",
]LocaleTypeType#
# LocaleTypeType usage example
from mypy_boto3_workdocs.literals import LocaleTypeType
def get_value() -> LocaleTypeType:
return "de"# LocaleTypeType definition
LocaleTypeType = Literal[
"de",
"default",
"en",
"es",
"fr",
"ja",
"ko",
"pt_BR",
"ru",
"zh_CN",
"zh_TW",
]OrderByFieldTypeType#
# OrderByFieldTypeType usage example
from mypy_boto3_workdocs.literals import OrderByFieldTypeType
def get_value() -> OrderByFieldTypeType:
return "CREATED_TIMESTAMP"# OrderByFieldTypeType definition
OrderByFieldTypeType = Literal[
"CREATED_TIMESTAMP",
"MODIFIED_TIMESTAMP",
"NAME",
"RELEVANCE",
"SIZE",
]OrderTypeType#
# OrderTypeType usage example
from mypy_boto3_workdocs.literals import OrderTypeType
def get_value() -> OrderTypeType:
return "ASCENDING"# OrderTypeType definition
OrderTypeType = Literal[
"ASCENDING",
"DESCENDING",
]PrincipalRoleTypeType#
# PrincipalRoleTypeType usage example
from mypy_boto3_workdocs.literals import PrincipalRoleTypeType
def get_value() -> PrincipalRoleTypeType:
return "CONTRIBUTOR"# PrincipalRoleTypeType definition
PrincipalRoleTypeType = Literal[
"CONTRIBUTOR",
"COOWNER",
"OWNER",
"VIEWER",
]PrincipalTypeType#
# PrincipalTypeType usage example
from mypy_boto3_workdocs.literals import PrincipalTypeType
def get_value() -> PrincipalTypeType:
return "ANONYMOUS"# PrincipalTypeType definition
PrincipalTypeType = Literal[
"ANONYMOUS",
"GROUP",
"INVITE",
"ORGANIZATION",
"USER",
]ResourceCollectionTypeType#
# ResourceCollectionTypeType usage example
from mypy_boto3_workdocs.literals import ResourceCollectionTypeType
def get_value() -> ResourceCollectionTypeType:
return "SHARED_WITH_ME"# ResourceCollectionTypeType definition
ResourceCollectionTypeType = Literal[
"SHARED_WITH_ME",
]ResourceSortTypeType#
# ResourceSortTypeType usage example
from mypy_boto3_workdocs.literals import ResourceSortTypeType
def get_value() -> ResourceSortTypeType:
return "DATE"# ResourceSortTypeType definition
ResourceSortTypeType = Literal[
"DATE",
"NAME",
]ResourceStateTypeType#
# ResourceStateTypeType usage example
from mypy_boto3_workdocs.literals import ResourceStateTypeType
def get_value() -> ResourceStateTypeType:
return "ACTIVE"# ResourceStateTypeType definition
ResourceStateTypeType = Literal[
"ACTIVE",
"RECYCLED",
"RECYCLING",
"RESTORING",
]ResourceTypeType#
# ResourceTypeType usage example
from mypy_boto3_workdocs.literals import ResourceTypeType
def get_value() -> ResourceTypeType:
return "DOCUMENT"# ResourceTypeType definition
ResourceTypeType = Literal[
"DOCUMENT",
"FOLDER",
]ResponseItemTypeType#
# ResponseItemTypeType usage example
from mypy_boto3_workdocs.literals import ResponseItemTypeType
def get_value() -> ResponseItemTypeType:
return "COMMENT"# ResponseItemTypeType definition
ResponseItemTypeType = Literal[
"COMMENT",
"DOCUMENT",
"DOCUMENT_VERSION",
"FOLDER",
]RolePermissionTypeType#
# RolePermissionTypeType usage example
from mypy_boto3_workdocs.literals import RolePermissionTypeType
def get_value() -> RolePermissionTypeType:
return "DIRECT"# RolePermissionTypeType definition
RolePermissionTypeType = Literal[
"DIRECT",
"INHERITED",
]RoleTypeType#
# RoleTypeType usage example
from mypy_boto3_workdocs.literals import RoleTypeType
def get_value() -> RoleTypeType:
return "CONTRIBUTOR"# RoleTypeType definition
RoleTypeType = Literal[
"CONTRIBUTOR",
"COOWNER",
"OWNER",
"VIEWER",
]SearchCollectionTypeType#
# SearchCollectionTypeType usage example
from mypy_boto3_workdocs.literals import SearchCollectionTypeType
def get_value() -> SearchCollectionTypeType:
return "OWNED"# SearchCollectionTypeType definition
SearchCollectionTypeType = Literal[
"OWNED",
"SHARED_WITH_ME",
]SearchQueryScopeTypeType#
# SearchQueryScopeTypeType usage example
from mypy_boto3_workdocs.literals import SearchQueryScopeTypeType
def get_value() -> SearchQueryScopeTypeType:
return "CONTENT"# SearchQueryScopeTypeType definition
SearchQueryScopeTypeType = Literal[
"CONTENT",
"NAME",
]SearchResourceTypeType#
# SearchResourceTypeType usage example
from mypy_boto3_workdocs.literals import SearchResourceTypeType
def get_value() -> SearchResourceTypeType:
return "COMMENT"# SearchResourceTypeType definition
SearchResourceTypeType = Literal[
"COMMENT",
"DOCUMENT",
"DOCUMENT_VERSION",
"FOLDER",
]SearchResourcesPaginatorName#
# SearchResourcesPaginatorName usage example
from mypy_boto3_workdocs.literals import SearchResourcesPaginatorName
def get_value() -> SearchResourcesPaginatorName:
return "search_resources"# SearchResourcesPaginatorName definition
SearchResourcesPaginatorName = Literal[
"search_resources",
]ShareStatusTypeType#
# ShareStatusTypeType usage example
from mypy_boto3_workdocs.literals import ShareStatusTypeType
def get_value() -> ShareStatusTypeType:
return "FAILURE"# ShareStatusTypeType definition
ShareStatusTypeType = Literal[
"FAILURE",
"SUCCESS",
]SortOrderType#
# SortOrderType usage example
from mypy_boto3_workdocs.literals import SortOrderType
def get_value() -> SortOrderType:
return "ASC"# SortOrderType definition
SortOrderType = Literal[
"ASC",
"DESC",
]StorageTypeType#
# StorageTypeType usage example
from mypy_boto3_workdocs.literals import StorageTypeType
def get_value() -> StorageTypeType:
return "QUOTA"# StorageTypeType definition
StorageTypeType = Literal[
"QUOTA",
"UNLIMITED",
]SubscriptionProtocolTypeType#
# SubscriptionProtocolTypeType usage example
from mypy_boto3_workdocs.literals import SubscriptionProtocolTypeType
def get_value() -> SubscriptionProtocolTypeType:
return "HTTPS"# SubscriptionProtocolTypeType definition
SubscriptionProtocolTypeType = Literal[
"HTTPS",
"SQS",
]SubscriptionTypeType#
# SubscriptionTypeType usage example
from mypy_boto3_workdocs.literals import SubscriptionTypeType
def get_value() -> SubscriptionTypeType:
return "ALL"# SubscriptionTypeType definition
SubscriptionTypeType = Literal[
"ALL",
]UserFilterTypeType#
# UserFilterTypeType usage example
from mypy_boto3_workdocs.literals import UserFilterTypeType
def get_value() -> UserFilterTypeType:
return "ACTIVE_PENDING"# UserFilterTypeType definition
UserFilterTypeType = Literal[
"ACTIVE_PENDING",
"ALL",
]UserSortTypeType#
# UserSortTypeType usage example
from mypy_boto3_workdocs.literals import UserSortTypeType
def get_value() -> UserSortTypeType:
return "FULL_NAME"# UserSortTypeType definition
UserSortTypeType = Literal[
"FULL_NAME",
"STORAGE_LIMIT",
"STORAGE_USED",
"USER_NAME",
"USER_STATUS",
]UserStatusTypeType#
# UserStatusTypeType usage example
from mypy_boto3_workdocs.literals import UserStatusTypeType
def get_value() -> UserStatusTypeType:
return "ACTIVE"# UserStatusTypeType definition
UserStatusTypeType = Literal[
"ACTIVE",
"INACTIVE",
"PENDING",
]UserTypeType#
# UserTypeType usage example
from mypy_boto3_workdocs.literals import UserTypeType
def get_value() -> UserTypeType:
return "ADMIN"# UserTypeType definition
UserTypeType = Literal[
"ADMIN",
"MINIMALUSER",
"POWERUSER",
"USER",
"WORKSPACESUSER",
]WorkDocsServiceName#
# WorkDocsServiceName usage example
from mypy_boto3_workdocs.literals import WorkDocsServiceName
def get_value() -> WorkDocsServiceName:
return "workdocs"# WorkDocsServiceName definition
WorkDocsServiceName = Literal[
"workdocs",
]ServiceName#
# ServiceName usage example
from mypy_boto3_workdocs.literals import ServiceName
def get_value() -> ServiceName:
return "accessanalyzer"# ServiceName definition
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appfabric",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"application-signals",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"apptest",
"arc-zonal-shift",
"artifact",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"b2bi",
"backup",
"backup-gateway",
"batch",
"bcm-data-exports",
"bedrock",
"bedrock-agent",
"bedrock-agent-runtime",
"bedrock-runtime",
"billingconductor",
"braket",
"budgets",
"ce",
"chatbot",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cleanroomsml",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",