Literals#
Auto-generated documentation for WorkMail type annotations stubs module mypy-boto3-workmail.
AccessControlRuleEffectType#
# AccessControlRuleEffectType usage example
from mypy_boto3_workmail.literals import AccessControlRuleEffectType
def get_value() -> AccessControlRuleEffectType:
return "ALLOW"# AccessControlRuleEffectType definition
AccessControlRuleEffectType = Literal[
"ALLOW",
"DENY",
]AccessEffectType#
# AccessEffectType usage example
from mypy_boto3_workmail.literals import AccessEffectType
def get_value() -> AccessEffectType:
return "ALLOW"# AccessEffectType definition
AccessEffectType = Literal[
"ALLOW",
"DENY",
]AvailabilityProviderTypeType#
# AvailabilityProviderTypeType usage example
from mypy_boto3_workmail.literals import AvailabilityProviderTypeType
def get_value() -> AvailabilityProviderTypeType:
return "EWS"# AvailabilityProviderTypeType definition
AvailabilityProviderTypeType = Literal[
"EWS",
"LAMBDA",
]DnsRecordVerificationStatusType#
# DnsRecordVerificationStatusType usage example
from mypy_boto3_workmail.literals import DnsRecordVerificationStatusType
def get_value() -> DnsRecordVerificationStatusType:
return "FAILED"# DnsRecordVerificationStatusType definition
DnsRecordVerificationStatusType = Literal[
"FAILED",
"PENDING",
"VERIFIED",
]EntityStateType#
# EntityStateType usage example
from mypy_boto3_workmail.literals import EntityStateType
def get_value() -> EntityStateType:
return "DELETED"# EntityStateType definition
EntityStateType = Literal[
"DELETED",
"DISABLED",
"ENABLED",
]EntityTypeType#
# EntityTypeType usage example
from mypy_boto3_workmail.literals import EntityTypeType
def get_value() -> EntityTypeType:
return "GROUP"# EntityTypeType definition
EntityTypeType = Literal[
"GROUP",
"RESOURCE",
"USER",
]FolderNameType#
# FolderNameType usage example
from mypy_boto3_workmail.literals import FolderNameType
def get_value() -> FolderNameType:
return "DELETED_ITEMS"# FolderNameType definition
FolderNameType = Literal[
"DELETED_ITEMS",
"DRAFTS",
"INBOX",
"JUNK_EMAIL",
"SENT_ITEMS",
]IdentityProviderAuthenticationModeType#
# IdentityProviderAuthenticationModeType usage example
from mypy_boto3_workmail.literals import IdentityProviderAuthenticationModeType
def get_value() -> IdentityProviderAuthenticationModeType:
return "IDENTITY_PROVIDER_AND_DIRECTORY"# IdentityProviderAuthenticationModeType definition
IdentityProviderAuthenticationModeType = Literal[
"IDENTITY_PROVIDER_AND_DIRECTORY",
"IDENTITY_PROVIDER_ONLY",
]ImpersonationRoleTypeType#
# ImpersonationRoleTypeType usage example
from mypy_boto3_workmail.literals import ImpersonationRoleTypeType
def get_value() -> ImpersonationRoleTypeType:
return "FULL_ACCESS"# ImpersonationRoleTypeType definition
ImpersonationRoleTypeType = Literal[
"FULL_ACCESS",
"READ_ONLY",
]ListAliasesPaginatorName#
# ListAliasesPaginatorName usage example
from mypy_boto3_workmail.literals import ListAliasesPaginatorName
def get_value() -> ListAliasesPaginatorName:
return "list_aliases"# ListAliasesPaginatorName definition
ListAliasesPaginatorName = Literal[
"list_aliases",
]ListAvailabilityConfigurationsPaginatorName#
# ListAvailabilityConfigurationsPaginatorName usage example
from mypy_boto3_workmail.literals import ListAvailabilityConfigurationsPaginatorName
def get_value() -> ListAvailabilityConfigurationsPaginatorName:
return "list_availability_configurations"# ListAvailabilityConfigurationsPaginatorName definition
ListAvailabilityConfigurationsPaginatorName = Literal[
"list_availability_configurations",
]ListGroupMembersPaginatorName#
# ListGroupMembersPaginatorName usage example
from mypy_boto3_workmail.literals import ListGroupMembersPaginatorName
def get_value() -> ListGroupMembersPaginatorName:
return "list_group_members"# ListGroupMembersPaginatorName definition
ListGroupMembersPaginatorName = Literal[
"list_group_members",
]ListGroupsPaginatorName#
# ListGroupsPaginatorName usage example
from mypy_boto3_workmail.literals import ListGroupsPaginatorName
def get_value() -> ListGroupsPaginatorName:
return "list_groups"# ListGroupsPaginatorName definition
ListGroupsPaginatorName = Literal[
"list_groups",
]ListMailboxPermissionsPaginatorName#
# ListMailboxPermissionsPaginatorName usage example
from mypy_boto3_workmail.literals import ListMailboxPermissionsPaginatorName
def get_value() -> ListMailboxPermissionsPaginatorName:
return "list_mailbox_permissions"# ListMailboxPermissionsPaginatorName definition
ListMailboxPermissionsPaginatorName = Literal[
"list_mailbox_permissions",
]ListOrganizationsPaginatorName#
# ListOrganizationsPaginatorName usage example
from mypy_boto3_workmail.literals import ListOrganizationsPaginatorName
def get_value() -> ListOrganizationsPaginatorName:
return "list_organizations"# ListOrganizationsPaginatorName definition
ListOrganizationsPaginatorName = Literal[
"list_organizations",
]ListPersonalAccessTokensPaginatorName#
# ListPersonalAccessTokensPaginatorName usage example
from mypy_boto3_workmail.literals import ListPersonalAccessTokensPaginatorName
def get_value() -> ListPersonalAccessTokensPaginatorName:
return "list_personal_access_tokens"# ListPersonalAccessTokensPaginatorName definition
ListPersonalAccessTokensPaginatorName = Literal[
"list_personal_access_tokens",
]ListResourceDelegatesPaginatorName#
# ListResourceDelegatesPaginatorName usage example
from mypy_boto3_workmail.literals import ListResourceDelegatesPaginatorName
def get_value() -> ListResourceDelegatesPaginatorName:
return "list_resource_delegates"# ListResourceDelegatesPaginatorName definition
ListResourceDelegatesPaginatorName = Literal[
"list_resource_delegates",
]ListResourcesPaginatorName#
# ListResourcesPaginatorName usage example
from mypy_boto3_workmail.literals import ListResourcesPaginatorName
def get_value() -> ListResourcesPaginatorName:
return "list_resources"# ListResourcesPaginatorName definition
ListResourcesPaginatorName = Literal[
"list_resources",
]ListUsersPaginatorName#
# ListUsersPaginatorName usage example
from mypy_boto3_workmail.literals import ListUsersPaginatorName
def get_value() -> ListUsersPaginatorName:
return "list_users"# ListUsersPaginatorName definition
ListUsersPaginatorName = Literal[
"list_users",
]MailboxExportJobStateType#
# MailboxExportJobStateType usage example
from mypy_boto3_workmail.literals import MailboxExportJobStateType
def get_value() -> MailboxExportJobStateType:
return "CANCELLED"# MailboxExportJobStateType definition
MailboxExportJobStateType = Literal[
"CANCELLED",
"COMPLETED",
"FAILED",
"RUNNING",
]MemberTypeType#
# MemberTypeType usage example
from mypy_boto3_workmail.literals import MemberTypeType
def get_value() -> MemberTypeType:
return "GROUP"# MemberTypeType definition
MemberTypeType = Literal[
"GROUP",
"USER",
]MobileDeviceAccessRuleEffectType#
# MobileDeviceAccessRuleEffectType usage example
from mypy_boto3_workmail.literals import MobileDeviceAccessRuleEffectType
def get_value() -> MobileDeviceAccessRuleEffectType:
return "ALLOW"# MobileDeviceAccessRuleEffectType definition
MobileDeviceAccessRuleEffectType = Literal[
"ALLOW",
"DENY",
]PermissionTypeType#
# PermissionTypeType usage example
from mypy_boto3_workmail.literals import PermissionTypeType
def get_value() -> PermissionTypeType:
return "FULL_ACCESS"# PermissionTypeType definition
PermissionTypeType = Literal[
"FULL_ACCESS",
"SEND_AS",
"SEND_ON_BEHALF",
]PersonalAccessTokenConfigurationStatusType#
# PersonalAccessTokenConfigurationStatusType usage example
from mypy_boto3_workmail.literals import PersonalAccessTokenConfigurationStatusType
def get_value() -> PersonalAccessTokenConfigurationStatusType:
return "ACTIVE"# PersonalAccessTokenConfigurationStatusType definition
PersonalAccessTokenConfigurationStatusType = Literal[
"ACTIVE",
"INACTIVE",
]ResourceTypeType#
# ResourceTypeType usage example
from mypy_boto3_workmail.literals import ResourceTypeType
def get_value() -> ResourceTypeType:
return "EQUIPMENT"# ResourceTypeType definition
ResourceTypeType = Literal[
"EQUIPMENT",
"ROOM",
]RetentionActionType#
# RetentionActionType usage example
from mypy_boto3_workmail.literals import RetentionActionType
def get_value() -> RetentionActionType:
return "DELETE"# RetentionActionType definition
RetentionActionType = Literal[
"DELETE",
"NONE",
"PERMANENTLY_DELETE",
]UserRoleType#
# UserRoleType usage example
from mypy_boto3_workmail.literals import UserRoleType
def get_value() -> UserRoleType:
return "REMOTE_USER"# UserRoleType definition
UserRoleType = Literal[
"REMOTE_USER",
"RESOURCE",
"SYSTEM_USER",
"USER",
]WorkMailServiceName#
# WorkMailServiceName usage example
from mypy_boto3_workmail.literals import WorkMailServiceName
def get_value() -> WorkMailServiceName:
return "workmail"# WorkMailServiceName definition
WorkMailServiceName = Literal[
"workmail",
]ServiceName#
# ServiceName usage example
from mypy_boto3_workmail.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",
"backupsearch",
"batch",
"bcm-data-exports",
"bcm-pricing-calculator",
"bedrock",
"bedrock-agent",
"bedrock-agent-runtime",
"bedrock-data-automation",
"bedrock-data-automation-runtime",
"bedrock-runtime",
"billing",
"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",
"cloudfront-keyvaluestore",
"cloudhsm",
"cloudhsmv2",
"cloudsearch",
"cloudsearchdomain",
"cloudtrail",
"cloudtrail-data",
"cloudwatch",
"codeartifact",
"codebuild",
"codecatalyst",
"codecommit",
"codeconnections",
"codedeploy",
"codeguru-reviewer",
"codeguru-security",
"codeguruprofiler",
"codepipeline",
"codestar-connections",
"codestar-notifications",
"cognito-identity",
"cognito-idp",
"cognito-sync",
"comprehend",
"comprehendmedical",
"compute-optimizer",
"config",
"connect",
"connect-contact-lens",
"connectcampaigns",
"connectcampaignsv2",
"connectcases",
"connectparticipant",
"controlcatalog",
"controltower",
"cost-optimization-hub",
"cur",
"customer-profiles",
"databrew",
"dataexchange",
"datapipeline",
"datasync",
"datazone",
"dax",
"deadline",
"detective",
"devicefarm",
"devops-guru",
"directconnect",
"discovery",
"dlm",
"dms",
"docdb",
"docdb-elastic",
"drs",
"ds",
"ds-data",
"dsql",
"dynamodb",
"dynamodbstreams",
"ebs",
"ec2",
"ec2-instance-connect",
"ecr",
"ecr-public",
"ecs",
"efs",
"eks",
"eks-auth",
"elastic-inference",
"elasticache",
"elasticbeanstalk",
"elastictranscoder",
"elb",
"elbv2",
"emr",
"emr-containers",
"emr-serverless",
"entityresolution",
"es",
"events",
"evidently",
"finspace",
"finspace-data",
"firehose",
"fis",
"fms",
"forecast",
"forecastquery",
"frauddetector",
"freetier",
"fsx",
"gamelift",
"geo-maps",
"geo-places",
"geo-routes",
"glacier",
"globalaccelerator",
"glue",
"grafana",
"greengrass",
"greengrassv2",
"groundstation",
"guardduty",
"health",
"healthlake",
"iam",
"identitystore",
"imagebuilder",
"importexport",
"inspector",
"inspector-scan",
"inspector2",
"internetmonitor",
"invoicing",
"iot",
"iot-data",
"iot-jobs-data",
"iot1click-devices",
"iot1click-projects",
"iotanalytics",
"iotdeviceadvisor",
"iotevents",
"iotevents-data",
"iotfleethub",
"iotfleetwise",
"iotsecuretunneling",
"iotsitewise",
"iotthingsgraph",
"iottwinmaker",
"iotwireless",
"ivs",
"ivs-realtime",
"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",
"launch-wizard",
"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",
"macie2",
"mailmanager",
"managedblockchain",
"managedblockchain-query",
"marketplace-agreement",
"marketplace-catalog",
"marketplace-deployment",
"marketplace-entitlement",
"marketplace-reporting",
"marketplacecommerceanalytics",
"mediaconnect",
"mediaconvert",
"medialive",
"mediapackage",
"mediapackage-vod",
"mediapackagev2",
"mediastore",
"mediastore-data",
"mediatailor",
"medical-imaging",
"memorydb",
"meteringmarketplace",
"mgh",
"mgn",
"migration-hub-refactor-spaces",
"migrationhub-config",
"migrationhuborchestrator",
"migrationhubstrategy",
"mq",
"mturk",
"mwaa",
"neptune",
"neptune-graph",
"neptunedata",
"network-firewall",
"networkflowmonitor",
"networkmanager",
"networkmonitor",
"notifications",
"notificationscontacts",
"oam",
"observabilityadmin",
"omics",
"opensearch",
"opensearchserverless",
"opsworks",
"opsworkscm",
"organizations",
"osis",
"outposts",
"panorama",
"partnercentral-selling",
"payment-cryptography",
"payment-cryptography-data",
"pca-connector-ad",
"pca-connector-scep",
"pcs",
"personalize",
"personalize-events",
"personalize-runtime",
"pi",
"pinpoint",
"pinpoint-email",
"pinpoint-sms-voice",
"pinpoint-sms-voice-v2",
"pipes",
"polly",
"pricing",
"privatenetworks",
"proton",
"qapps",
"qbusiness",
"qconnect",
"qldb",
"qldb-session",
"quicksight",
"ram",
"rbin",
"rds",
"rds-data",
"redshift",
"redshift-data",
"redshift-serverless",
"rekognition",
"repostspace",
"resiliencehub",
"resource-explorer-2",
"resource-groups",
"resourcegroupstaggingapi",
"robomaker",
"rolesanywhere",
"route53",
"route53-recovery-cluster",
"route53-recovery-control-config",
"route53-recovery-readiness",
"route53domains",
"route53profiles",
"route53resolver",
"rum",
"s3",
"s3control",
"s3outposts",
"s3tables",
"sagemaker",
"sagemaker-a2i-runtime",
"sagemaker-edge",
"sagemaker-featurestore-runtime",
"sagemaker-geospatial",
"sagemaker-metrics",
"sagemaker-runtime",
"savingsplans",
"scheduler",
"schemas",
"sdb",
"secretsmanager",
"security-ir",
"securityhub",
"securitylake",
"serverlessrepo",
"service-quotas",
"servicecatalog",
"servicecatalog-appregistry",
"servicediscovery",
"ses",
"sesv2",
"shield",
"signer",
"simspaceweaver",
"sms",
"sms-voice",
"snow-device-management",
"snowball",
"sns",
"socialmessaging",
"sqs",
"ssm",
"ssm-contacts",
"ssm-incidents",
"ssm-quicksetup",
"ssm-sap",
"sso",
"sso-admin",
"sso-oidc",
"stepfunctions",
"storagegateway",
"sts",
"supplychain",
"support",
"support-app",
"swf",
"synthetics",
"taxsettings",
"textract",
"timestream-influxdb",
"timestream-query",
"timestream-write",
"tnb",
"transcribe",
"transfer",
"translate",
"trustedadvisor",
"verifiedpermissions",
"voice-id",
"vpc-lattice",
"waf",
"waf-regional",
"wafv2",
"wellarchitected",
"wisdom",
"workdocs",
"workmail",
"workmailmessageflow",
"workspaces",
"workspaces-thin-client",
"workspaces-web",
"xray",
]ResourceServiceName#
# ResourceServiceName usage example
from mypy_boto3_workmail.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"# ResourceServiceName definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]PaginatorName#
# PaginatorName usage example
from mypy_boto3_workmail.literals import PaginatorName
def get_value() -> PaginatorName:
return "list_aliases"# PaginatorName definition
PaginatorName = Literal[
"list_aliases",
"list_availability_configurations",
"list_group_members",
"list_groups",
"list_mailbox_permissions",
"list_organizations",
"list_personal_access_tokens",
"list_resource_delegates",
"list_resources",
"list_users",
]RegionName#
# RegionName usage example
from mypy_boto3_workmail.literals import RegionName
def get_value() -> RegionName:
return "eu-west-1"# RegionName definition
RegionName = Literal[
"eu-west-1",
"us-east-1",
"us-west-2",
]