Literals
Auto-generated documentation for WorkDocs type annotations stubs module mypy-boto3-workdocs.
ActivityTypeType
Usage Example
from mypy_boto3_workdocs.literals import ActivityTypeType
def get_value() -> ActivityTypeType:
return "DOCUMENT_ANNOTATION_ADDED"
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",
]
BooleanEnumTypeType
Usage Example
from mypy_boto3_workdocs.literals import BooleanEnumTypeType
def get_value() -> BooleanEnumTypeType:
return "FALSE"
CommentStatusTypeType
Usage Example
from mypy_boto3_workdocs.literals import CommentStatusTypeType
def get_value() -> CommentStatusTypeType:
return "DELETED"
CommentVisibilityTypeType
Usage Example
from mypy_boto3_workdocs.literals import CommentVisibilityTypeType
def get_value() -> CommentVisibilityTypeType:
return "PRIVATE"
DescribeActivitiesPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeActivitiesPaginatorName
def get_value() -> DescribeActivitiesPaginatorName:
return "describe_activities"
DescribeCommentsPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeCommentsPaginatorName
def get_value() -> DescribeCommentsPaginatorName:
return "describe_comments"
DescribeDocumentVersionsPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeDocumentVersionsPaginatorName
def get_value() -> DescribeDocumentVersionsPaginatorName:
return "describe_document_versions"
DescribeFolderContentsPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeFolderContentsPaginatorName
def get_value() -> DescribeFolderContentsPaginatorName:
return "describe_folder_contents"
DescribeGroupsPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeGroupsPaginatorName
def get_value() -> DescribeGroupsPaginatorName:
return "describe_groups"
DescribeNotificationSubscriptionsPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeNotificationSubscriptionsPaginatorName
def get_value() -> DescribeNotificationSubscriptionsPaginatorName:
return "describe_notification_subscriptions"
Definition
DescribeNotificationSubscriptionsPaginatorName = Literal[
"describe_notification_subscriptions",
]
DescribeResourcePermissionsPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeResourcePermissionsPaginatorName
def get_value() -> DescribeResourcePermissionsPaginatorName:
return "describe_resource_permissions"
DescribeRootFoldersPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeRootFoldersPaginatorName
def get_value() -> DescribeRootFoldersPaginatorName:
return "describe_root_folders"
DescribeUsersPaginatorName
Usage Example
from mypy_boto3_workdocs.literals import DescribeUsersPaginatorName
def get_value() -> DescribeUsersPaginatorName:
return "describe_users"
DocumentSourceTypeType
Usage Example
from mypy_boto3_workdocs.literals import DocumentSourceTypeType
def get_value() -> DocumentSourceTypeType:
return "ORIGINAL"
DocumentStatusTypeType
Usage Example
from mypy_boto3_workdocs.literals import DocumentStatusTypeType
def get_value() -> DocumentStatusTypeType:
return "ACTIVE"
DocumentThumbnailTypeType
Usage Example
from mypy_boto3_workdocs.literals import DocumentThumbnailTypeType
def get_value() -> DocumentThumbnailTypeType:
return "LARGE"
DocumentVersionStatusType
Usage Example
from mypy_boto3_workdocs.literals import DocumentVersionStatusType
def get_value() -> DocumentVersionStatusType:
return "ACTIVE"
FolderContentTypeType
Usage Example
from mypy_boto3_workdocs.literals import FolderContentTypeType
def get_value() -> FolderContentTypeType:
return "ALL"
LocaleTypeType
Usage Example
from mypy_boto3_workdocs.literals import LocaleTypeType
def get_value() -> LocaleTypeType:
return "de"
Definition
LocaleTypeType = Literal[
"de",
"default",
"en",
"es",
"fr",
"ja",
"ko",
"pt_BR",
"ru",
"zh_CN",
"zh_TW",
]
OrderTypeType
Usage Example
from mypy_boto3_workdocs.literals import OrderTypeType
def get_value() -> OrderTypeType:
return "ASCENDING"
PrincipalTypeType
Usage Example
from mypy_boto3_workdocs.literals import PrincipalTypeType
def get_value() -> PrincipalTypeType:
return "ANONYMOUS"
ResourceCollectionTypeType
Usage Example
from mypy_boto3_workdocs.literals import ResourceCollectionTypeType
def get_value() -> ResourceCollectionTypeType:
return "SHARED_WITH_ME"
ResourceSortTypeType
Usage Example
from mypy_boto3_workdocs.literals import ResourceSortTypeType
def get_value() -> ResourceSortTypeType:
return "DATE"
ResourceStateTypeType
Usage Example
from mypy_boto3_workdocs.literals import ResourceStateTypeType
def get_value() -> ResourceStateTypeType:
return "ACTIVE"
ResourceTypeType
Usage Example
from mypy_boto3_workdocs.literals import ResourceTypeType
def get_value() -> ResourceTypeType:
return "DOCUMENT"
RolePermissionTypeType
Usage Example
from mypy_boto3_workdocs.literals import RolePermissionTypeType
def get_value() -> RolePermissionTypeType:
return "DIRECT"
RoleTypeType
Usage Example
from mypy_boto3_workdocs.literals import RoleTypeType
def get_value() -> RoleTypeType:
return "CONTRIBUTOR"
ShareStatusTypeType
Usage Example
from mypy_boto3_workdocs.literals import ShareStatusTypeType
def get_value() -> ShareStatusTypeType:
return "FAILURE"
StorageTypeType
Usage Example
from mypy_boto3_workdocs.literals import StorageTypeType
def get_value() -> StorageTypeType:
return "QUOTA"
SubscriptionProtocolTypeType
Usage Example
from mypy_boto3_workdocs.literals import SubscriptionProtocolTypeType
def get_value() -> SubscriptionProtocolTypeType:
return "HTTPS"
SubscriptionTypeType
Usage Example
from mypy_boto3_workdocs.literals import SubscriptionTypeType
def get_value() -> SubscriptionTypeType:
return "ALL"
UserFilterTypeType
Usage Example
from mypy_boto3_workdocs.literals import UserFilterTypeType
def get_value() -> UserFilterTypeType:
return "ACTIVE_PENDING"
UserSortTypeType
Usage Example
from mypy_boto3_workdocs.literals import UserSortTypeType
def get_value() -> UserSortTypeType:
return "FULL_NAME"
Definition
UserSortTypeType = Literal[
"FULL_NAME",
"STORAGE_LIMIT",
"STORAGE_USED",
"USER_NAME",
"USER_STATUS",
]
UserStatusTypeType
Usage Example
from mypy_boto3_workdocs.literals import UserStatusTypeType
def get_value() -> UserStatusTypeType:
return "ACTIVE"
UserTypeType
Usage Example
from mypy_boto3_workdocs.literals import UserTypeType
def get_value() -> UserTypeType:
return "ADMIN"
WorkDocsServiceName
Usage Example
from mypy_boto3_workdocs.literals import WorkDocsServiceName
def get_value() -> WorkDocsServiceName:
return "workdocs"
ServiceName
Usage Example
from mypy_boto3_workdocs.literals import ServiceName
def get_value() -> ServiceName:
return "accessanalyzer"
Definition
ServiceName = Literal[
"accessanalyzer",
"account",
"acm",
"acm-pca",
"alexaforbusiness",
"amp",
"amplify",
"amplifybackend",
"amplifyuibuilder",
"apigateway",
"apigatewaymanagementapi",
"apigatewayv2",
"appconfig",
"appconfigdata",
"appflow",
"appintegrations",
"application-autoscaling",
"application-insights",
"applicationcostprofiler",
"appmesh",
"apprunner",
"appstream",
"appsync",
"arc-zonal-shift",
"athena",
"auditmanager",
"autoscaling",
"autoscaling-plans",
"backup",
"backup-gateway",
"backupstorage",
"batch",
"billingconductor",
"braket",
"budgets",
"ce",
"chime",
"chime-sdk-identity",
"chime-sdk-media-pipelines",
"chime-sdk-meetings",
"chime-sdk-messaging",
"chime-sdk-voice",
"cleanrooms",
"cloud9",
"cloudcontrol",
"clouddirectory",
"cloudformation",
"cloudfront",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codedeploy",
"codeguru-reviewer",
"codeguruprofiler",
"codepipeline",
"codestar",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcases",
"connectparticipant",
"controltower",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"dax",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
"ecr-public",
"ecs",
"efs",
"eks",
"elastic-inference",
"elasticache",
"elasticbeanstalk",
"elastictranscoder",
"elb",
"elbv2",
"emr",
"emr-containers",
"emr-serverless",
"es",
"events",
"evidently",
"finspace",
"finspace-data",
"firehose",
"fis",
"fms",
"forecast",
"forecastquery",
"frauddetector",
"fsx",
"gamelift",
"gamesparks",
"glacier",
"globalaccelerator",
"glue",
"grafana",
"greengrass",
"greengrassv2",
"groundstation",
"guardduty",
"health",
"healthlake",
"honeycode",
"iam",
"identitystore",
"imagebuilder",
"importexport",
"inspector",
"inspector2",
"internetmonitor",
"iot",
"iot-data",
"iot-jobs-data",
"iot-roborunner",
"iot1click-devices",
"iot1click-projects",
"iotanalytics",
"iotdeviceadvisor",
"iotevents",
"iotevents-data",
"iotfleethub",
"iotfleetwise",
"iotsecuretunneling",
"iotsitewise",
"iotthingsgraph",
"iottwinmaker",
"iotwireless",
"ivs",
"ivschat",
"kafka",
"kafkaconnect",
"kendra",
"kendra-ranking",
"keyspaces",
"kinesis",
"kinesis-video-archived-media",
"kinesis-video-media",
"kinesis-video-signaling",
"kinesis-video-webrtc-storage",
"kinesisanalytics",
"kinesisanalyticsv2",
"kinesisvideo",
"kms",
"lakeformation",
"lambda",
"lex-models",
"lex-runtime",
"lexv2-models",
"lexv2-runtime",
"license-manager",
"license-manager-linux-subscriptions",
"license-manager-user-subscriptions",
"lightsail",
"location",
"logs",
"lookoutequipment",
"lookoutmetrics",
"lookoutvision",
"m2",
"machinelearning",
"macie",
"macie2",
"managedblockchain",
"marketplace-catalog",
"marketplace-entitlement",
"marketplacecommerceanalytics",
"mediaconnect",
"mediaconvert",
"medialive",
"mediapackage",
"mediapackage-vod",
"mediastore",
"mediastore-data",
"mediatailor",
"memorydb",
"meteringmarketplace",
"mgh",
"mgn",
"migration-hub-refactor-spaces",
"migrationhub-config",
"migrationhuborchestrator",
"migrationhubstrategy",
"mobile",
"mq",
"mturk",
"mwaa",
"neptune",
"network-firewall",
"networkmanager",
"nimble",
"oam",
"omics",
"opensearch",
"opensearchserverless",
"opsworks",
"opsworkscm",
"organizations",
"outposts",
"panorama",
"personalize",
"personalize-events",
"personalize-runtime",
"pi",
"pinpoint",
"pinpoint-email",
"pinpoint-sms-voice",
"pinpoint-sms-voice-v2",
"pipes",
"polly",
"pricing",
"privatenetworks",
"proton",
"qldb",
"qldb-session",
"quicksight",
"ram",
"rbin",
"rds",
"rds-data",
"redshift",
"redshift-data",
"redshift-serverless",
"rekognition",
"resiliencehub",
"resource-explorer-2",
"resource-groups",
"resourcegroupstaggingapi",
"robomaker",
"rolesanywhere",
"route53",
"route53-recovery-cluster",
"route53-recovery-control-config",
"route53-recovery-readiness",
"route53domains",
"route53resolver",
"rum",
"s3",
"s3control",
"s3outposts",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"securityhub",
"securitylake",
"serverlessrepo",
"service-quotas",
"servicecatalog",
"servicecatalog-appregistry",
"servicediscovery",
"ses",
"sesv2",
"shield",
"signer",
"simspaceweaver",
"sms",
"sms-voice",
"snow-device-management",
"snowball",
"sns",
"sqs",
"ssm",
"ssm-contacts",
"ssm-incidents",
"ssm-sap",
"sso",
"sso-admin",
"sso-oidc",
"stepfunctions",
"storagegateway",
"sts",
"support",
"support-app",
"swf",
"synthetics",
"textract",
"timestream-query",
"timestream-write",
"tnb",
"transcribe",
"transfer",
"translate",
"voice-id",
"waf",
"waf-regional",
"wafv2",
"wellarchitected",
"wisdom",
"workdocs",
"worklink",
"workmail",
"workmailmessageflow",
"workspaces",
"workspaces-web",
"xray",
]
ResourceServiceName
Usage Example
from mypy_boto3_workdocs.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"
Definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]
PaginatorName
Usage Example
from mypy_boto3_workdocs.literals import PaginatorName
def get_value() -> PaginatorName:
return "describe_activities"
Definition
PaginatorName = Literal[
"describe_activities",
"describe_comments",
"describe_document_versions",
"describe_folder_contents",
"describe_groups",
"describe_notification_subscriptions",
"describe_resource_permissions",
"describe_root_folders",
"describe_users",
]