Literals
Auto-generated documentation for kendra type annotations stubs module mypy-boto3-kendra.
AdditionalResultAttributeValueTypeType
Usage Example
from mypy_boto3_kendra.literals import AdditionalResultAttributeValueTypeType
def get_value() -> AdditionalResultAttributeValueTypeType:
return "TEXT_WITH_HIGHLIGHTS_VALUE"
AlfrescoEntityType
Usage Example
from mypy_boto3_kendra.literals import AlfrescoEntityType
def get_value() -> AlfrescoEntityType:
return "blog"
ConditionOperatorType
Usage Example
from mypy_boto3_kendra.literals import ConditionOperatorType
def get_value() -> ConditionOperatorType:
return "BeginsWith"
Definition
ConditionOperatorType = Literal[
"BeginsWith",
"Contains",
"Equals",
"Exists",
"GreaterThan",
"GreaterThanOrEquals",
"LessThan",
"LessThanOrEquals",
"NotContains",
"NotEquals",
"NotExists",
]
ConfluenceAttachmentFieldNameType
Usage Example
from mypy_boto3_kendra.literals import ConfluenceAttachmentFieldNameType
def get_value() -> ConfluenceAttachmentFieldNameType:
return "AUTHOR"
Definition
ConfluenceAttachmentFieldNameType = Literal[
"AUTHOR",
"CONTENT_TYPE",
"CREATED_DATE",
"DISPLAY_URL",
"FILE_SIZE",
"ITEM_TYPE",
"PARENT_ID",
"SPACE_KEY",
"SPACE_NAME",
"URL",
"VERSION",
]
ConfluenceAuthenticationTypeType
Usage Example
from mypy_boto3_kendra.literals import ConfluenceAuthenticationTypeType
def get_value() -> ConfluenceAuthenticationTypeType:
return "HTTP_BASIC"
ConfluenceBlogFieldNameType
Usage Example
from mypy_boto3_kendra.literals import ConfluenceBlogFieldNameType
def get_value() -> ConfluenceBlogFieldNameType:
return "AUTHOR"
Definition
ConfluenceBlogFieldNameType = Literal[
"AUTHOR",
"DISPLAY_URL",
"ITEM_TYPE",
"LABELS",
"PUBLISH_DATE",
"SPACE_KEY",
"SPACE_NAME",
"URL",
"VERSION",
]
ConfluencePageFieldNameType
Usage Example
from mypy_boto3_kendra.literals import ConfluencePageFieldNameType
def get_value() -> ConfluencePageFieldNameType:
return "AUTHOR"
Definition
ConfluencePageFieldNameType = Literal[
"AUTHOR",
"CONTENT_STATUS",
"CREATED_DATE",
"DISPLAY_URL",
"ITEM_TYPE",
"LABELS",
"MODIFIED_DATE",
"PARENT_ID",
"SPACE_KEY",
"SPACE_NAME",
"URL",
"VERSION",
]
ConfluenceSpaceFieldNameType
Usage Example
from mypy_boto3_kendra.literals import ConfluenceSpaceFieldNameType
def get_value() -> ConfluenceSpaceFieldNameType:
return "DISPLAY_URL"
ConfluenceVersionType
Usage Example
from mypy_boto3_kendra.literals import ConfluenceVersionType
def get_value() -> ConfluenceVersionType:
return "CLOUD"
ContentTypeType
Usage Example
from mypy_boto3_kendra.literals import ContentTypeType
def get_value() -> ContentTypeType:
return "CSV"
Definition
ContentTypeType = Literal[
"CSV",
"HTML",
"JSON",
"MD",
"MS_EXCEL",
"MS_WORD",
"PDF",
"PLAIN_TEXT",
"PPT",
"RTF",
"XML",
"XSLT",
]
DataSourceStatusType
Usage Example
from mypy_boto3_kendra.literals import DataSourceStatusType
def get_value() -> DataSourceStatusType:
return "ACTIVE"
DataSourceSyncJobStatusType
Usage Example
from mypy_boto3_kendra.literals import DataSourceSyncJobStatusType
def get_value() -> DataSourceSyncJobStatusType:
return "ABORTED"
Definition
DataSourceSyncJobStatusType = Literal[
"ABORTED",
"FAILED",
"INCOMPLETE",
"STOPPING",
"SUCCEEDED",
"SYNCING",
"SYNCING_INDEXING",
]
DataSourceTypeType
Usage Example
from mypy_boto3_kendra.literals import DataSourceTypeType
def get_value() -> DataSourceTypeType:
return "ALFRESCO"
Definition
DataSourceTypeType = Literal[
"ALFRESCO",
"BOX",
"CONFLUENCE",
"CUSTOM",
"DATABASE",
"FSX",
"GITHUB",
"GOOGLEDRIVE",
"JIRA",
"ONEDRIVE",
"QUIP",
"S3",
"SALESFORCE",
"SERVICENOW",
"SHAREPOINT",
"SLACK",
"TEMPLATE",
"WEBCRAWLER",
"WORKDOCS",
]
DatabaseEngineTypeType
Usage Example
from mypy_boto3_kendra.literals import DatabaseEngineTypeType
def get_value() -> DatabaseEngineTypeType:
return "RDS_AURORA_MYSQL"
Definition
DatabaseEngineTypeType = Literal[
"RDS_AURORA_MYSQL",
"RDS_AURORA_POSTGRESQL",
"RDS_MYSQL",
"RDS_POSTGRESQL",
]
DocumentAttributeValueTypeType
Usage Example
from mypy_boto3_kendra.literals import DocumentAttributeValueTypeType
def get_value() -> DocumentAttributeValueTypeType:
return "DATE_VALUE"
Definition
DocumentAttributeValueTypeType = Literal[
"DATE_VALUE",
"LONG_VALUE",
"STRING_LIST_VALUE",
"STRING_VALUE",
]
DocumentStatusType
Usage Example
from mypy_boto3_kendra.literals import DocumentStatusType
def get_value() -> DocumentStatusType:
return "FAILED"
Definition
DocumentStatusType = Literal[
"FAILED",
"INDEXED",
"NOT_FOUND",
"PROCESSING",
"UPDATE_FAILED",
"UPDATED",
]
EndpointTypeType
Usage Example
from mypy_boto3_kendra.literals import EndpointTypeType
def get_value() -> EndpointTypeType:
return "HOME"
EntityTypeType
Usage Example
from mypy_boto3_kendra.literals import EntityTypeType
def get_value() -> EntityTypeType:
return "GROUP"
ErrorCodeType
Usage Example
from mypy_boto3_kendra.literals import ErrorCodeType
def get_value() -> ErrorCodeType:
return "InternalError"
ExperienceStatusType
Usage Example
from mypy_boto3_kendra.literals import ExperienceStatusType
def get_value() -> ExperienceStatusType:
return "ACTIVE"
FaqFileFormatType
Usage Example
from mypy_boto3_kendra.literals import FaqFileFormatType
def get_value() -> FaqFileFormatType:
return "CSV"
FaqStatusType
Usage Example
from mypy_boto3_kendra.literals import FaqStatusType
def get_value() -> FaqStatusType:
return "ACTIVE"
FsxFileSystemTypeType
Usage Example
from mypy_boto3_kendra.literals import FsxFileSystemTypeType
def get_value() -> FsxFileSystemTypeType:
return "WINDOWS"
HighlightTypeType
Usage Example
from mypy_boto3_kendra.literals import HighlightTypeType
def get_value() -> HighlightTypeType:
return "STANDARD"
IndexEditionType
Usage Example
from mypy_boto3_kendra.literals import IndexEditionType
def get_value() -> IndexEditionType:
return "DEVELOPER_EDITION"
IndexStatusType
Usage Example
from mypy_boto3_kendra.literals import IndexStatusType
def get_value() -> IndexStatusType:
return "ACTIVE"
Definition
IndexStatusType = Literal[
"ACTIVE",
"CREATING",
"DELETING",
"FAILED",
"SYSTEM_UPDATING",
"UPDATING",
]
IntervalType
Usage Example
from mypy_boto3_kendra.literals import IntervalType
def get_value() -> IntervalType:
return "ONE_MONTH_AGO"
Definition
IntervalType = Literal[
"ONE_MONTH_AGO",
"ONE_WEEK_AGO",
"THIS_MONTH",
"THIS_WEEK",
"TWO_MONTHS_AGO",
"TWO_WEEKS_AGO",
]
IssueSubEntityType
Usage Example
from mypy_boto3_kendra.literals import IssueSubEntityType
def get_value() -> IssueSubEntityType:
return "ATTACHMENTS"
KeyLocationType
Usage Example
from mypy_boto3_kendra.literals import KeyLocationType
def get_value() -> KeyLocationType:
return "SECRET_MANAGER"
MetricTypeType
Usage Example
from mypy_boto3_kendra.literals import MetricTypeType
def get_value() -> MetricTypeType:
return "AGG_QUERY_DOC_METRICS"
Definition
MetricTypeType = Literal[
"AGG_QUERY_DOC_METRICS",
"DOCS_BY_CLICK_COUNT",
"QUERIES_BY_COUNT",
"QUERIES_BY_ZERO_CLICK_RATE",
"QUERIES_BY_ZERO_RESULT_RATE",
"TREND_QUERY_DOC_METRICS",
]
ModeType
Usage Example
from mypy_boto3_kendra.literals import ModeType
def get_value() -> ModeType:
return "ENABLED"
OrderType
Usage Example
from mypy_boto3_kendra.literals import OrderType
def get_value() -> OrderType:
return "ASCENDING"
PersonaType
Usage Example
from mypy_boto3_kendra.literals import PersonaType
def get_value() -> PersonaType:
return "OWNER"
PrincipalMappingStatusType
Usage Example
from mypy_boto3_kendra.literals import PrincipalMappingStatusType
def get_value() -> PrincipalMappingStatusType:
return "DELETED"
Definition
PrincipalMappingStatusType = Literal[
"DELETED",
"DELETING",
"FAILED",
"PROCESSING",
"SUCCEEDED",
]
PrincipalTypeType
Usage Example
from mypy_boto3_kendra.literals import PrincipalTypeType
def get_value() -> PrincipalTypeType:
return "GROUP"
QueryIdentifiersEnclosingOptionType
Usage Example
from mypy_boto3_kendra.literals import QueryIdentifiersEnclosingOptionType
def get_value() -> QueryIdentifiersEnclosingOptionType:
return "DOUBLE_QUOTES"
QueryResultFormatType
Usage Example
from mypy_boto3_kendra.literals import QueryResultFormatType
def get_value() -> QueryResultFormatType:
return "TABLE"
QueryResultTypeType
Usage Example
from mypy_boto3_kendra.literals import QueryResultTypeType
def get_value() -> QueryResultTypeType:
return "ANSWER"
QuerySuggestionsBlockListStatusType
Usage Example
from mypy_boto3_kendra.literals import QuerySuggestionsBlockListStatusType
def get_value() -> QuerySuggestionsBlockListStatusType:
return "ACTIVE"
Definition
QuerySuggestionsBlockListStatusType = Literal[
"ACTIVE",
"ACTIVE_BUT_UPDATE_FAILED",
"CREATING",
"DELETING",
"FAILED",
"UPDATING",
]
QuerySuggestionsStatusType
Usage Example
from mypy_boto3_kendra.literals import QuerySuggestionsStatusType
def get_value() -> QuerySuggestionsStatusType:
return "ACTIVE"
ReadAccessTypeType
Usage Example
from mypy_boto3_kendra.literals import ReadAccessTypeType
def get_value() -> ReadAccessTypeType:
return "ALLOW"
RelevanceTypeType
Usage Example
from mypy_boto3_kendra.literals import RelevanceTypeType
def get_value() -> RelevanceTypeType:
return "NOT_RELEVANT"
SalesforceChatterFeedIncludeFilterTypeType
Usage Example
from mypy_boto3_kendra.literals import SalesforceChatterFeedIncludeFilterTypeType
def get_value() -> SalesforceChatterFeedIncludeFilterTypeType:
return "ACTIVE_USER"
SalesforceKnowledgeArticleStateType
Usage Example
from mypy_boto3_kendra.literals import SalesforceKnowledgeArticleStateType
def get_value() -> SalesforceKnowledgeArticleStateType:
return "ARCHIVED"
SalesforceStandardObjectNameType
Usage Example
from mypy_boto3_kendra.literals import SalesforceStandardObjectNameType
def get_value() -> SalesforceStandardObjectNameType:
return "ACCOUNT"
Definition
SalesforceStandardObjectNameType = Literal[
"ACCOUNT",
"CAMPAIGN",
"CASE",
"CONTACT",
"CONTRACT",
"DOCUMENT",
"GROUP",
"IDEA",
"LEAD",
"OPPORTUNITY",
"PARTNER",
"PRICEBOOK",
"PRODUCT",
"PROFILE",
"SOLUTION",
"TASK",
"USER",
]
ScoreConfidenceType
Usage Example
from mypy_boto3_kendra.literals import ScoreConfidenceType
def get_value() -> ScoreConfidenceType:
return "HIGH"
ServiceNowAuthenticationTypeType
Usage Example
from mypy_boto3_kendra.literals import ServiceNowAuthenticationTypeType
def get_value() -> ServiceNowAuthenticationTypeType:
return "HTTP_BASIC"
ServiceNowBuildVersionTypeType
Usage Example
from mypy_boto3_kendra.literals import ServiceNowBuildVersionTypeType
def get_value() -> ServiceNowBuildVersionTypeType:
return "LONDON"
SharePointOnlineAuthenticationTypeType
Usage Example
from mypy_boto3_kendra.literals import SharePointOnlineAuthenticationTypeType
def get_value() -> SharePointOnlineAuthenticationTypeType:
return "HTTP_BASIC"
SharePointVersionType
Usage Example
from mypy_boto3_kendra.literals import SharePointVersionType
def get_value() -> SharePointVersionType:
return "SHAREPOINT_2013"
Definition
SharePointVersionType = Literal[
"SHAREPOINT_2013",
"SHAREPOINT_2016",
"SHAREPOINT_2019",
"SHAREPOINT_ONLINE",
]
SlackEntityType
Usage Example
from mypy_boto3_kendra.literals import SlackEntityType
def get_value() -> SlackEntityType:
return "DIRECT_MESSAGE"
Definition
SlackEntityType = Literal[
"DIRECT_MESSAGE",
"GROUP_MESSAGE",
"PRIVATE_CHANNEL",
"PUBLIC_CHANNEL",
]
SortOrderType
Usage Example
from mypy_boto3_kendra.literals import SortOrderType
def get_value() -> SortOrderType:
return "ASC"
ThesaurusStatusType
Usage Example
from mypy_boto3_kendra.literals import ThesaurusStatusType
def get_value() -> ThesaurusStatusType:
return "ACTIVE"
Definition
ThesaurusStatusType = Literal[
"ACTIVE",
"ACTIVE_BUT_UPDATE_FAILED",
"CREATING",
"DELETING",
"FAILED",
"UPDATING",
]
TypeType
Usage Example
from mypy_boto3_kendra.literals import TypeType
def get_value() -> TypeType:
return "ON_PREMISE"
UserContextPolicyType
Usage Example
from mypy_boto3_kendra.literals import UserContextPolicyType
def get_value() -> UserContextPolicyType:
return "ATTRIBUTE_FILTER"
UserGroupResolutionModeType
Usage Example
from mypy_boto3_kendra.literals import UserGroupResolutionModeType
def get_value() -> UserGroupResolutionModeType:
return "AWS_SSO"
WarningCodeType
Usage Example
from mypy_boto3_kendra.literals import WarningCodeType
def get_value() -> WarningCodeType:
return "QUERY_LANGUAGE_INVALID_SYNTAX"
WebCrawlerModeType
Usage Example
from mypy_boto3_kendra.literals import WebCrawlerModeType
def get_value() -> WebCrawlerModeType:
return "EVERYTHING"
kendraServiceName
Usage Example
from mypy_boto3_kendra.literals import kendraServiceName
def get_value() -> kendraServiceName:
return "kendra"
ServiceName
Usage Example
from mypy_boto3_kendra.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_kendra.literals import ResourceServiceName
def get_value() -> ResourceServiceName:
return "cloudformation"
Definition
ResourceServiceName = Literal[
"cloudformation",
"cloudwatch",
"dynamodb",
"ec2",
"glacier",
"iam",
"opsworks",
"s3",
"sns",
"sqs",
]