Literals#
Auto-generated documentation for QBusiness type annotations stubs module mypy-boto3-qbusiness.
APISchemaTypeType#
# APISchemaTypeType usage example
from mypy_boto3_qbusiness.literals import APISchemaTypeType
def get_value() -> APISchemaTypeType:
return "OPEN_API_V3"# APISchemaTypeType definition
APISchemaTypeType = Literal[
"OPEN_API_V3",
]ActionPayloadFieldTypeType#
# ActionPayloadFieldTypeType usage example
from mypy_boto3_qbusiness.literals import ActionPayloadFieldTypeType
def get_value() -> ActionPayloadFieldTypeType:
return "ARRAY"# ActionPayloadFieldTypeType definition
ActionPayloadFieldTypeType = Literal[
"ARRAY",
"BOOLEAN",
"NUMBER",
"STRING",
]ApplicationStatusType#
# ApplicationStatusType usage example
from mypy_boto3_qbusiness.literals import ApplicationStatusType
def get_value() -> ApplicationStatusType:
return "ACTIVE"# ApplicationStatusType definition
ApplicationStatusType = Literal[
"ACTIVE",
"CREATING",
"DELETING",
"FAILED",
"UPDATING",
]AttachmentStatusType#
# AttachmentStatusType usage example
from mypy_boto3_qbusiness.literals import AttachmentStatusType
def get_value() -> AttachmentStatusType:
return "FAILED"# AttachmentStatusType definition
AttachmentStatusType = Literal[
"FAILED",
"SUCCEEDED",
]AttachmentsControlModeType#
# AttachmentsControlModeType usage example
from mypy_boto3_qbusiness.literals import AttachmentsControlModeType
def get_value() -> AttachmentsControlModeType:
return "DISABLED"# AttachmentsControlModeType definition
AttachmentsControlModeType = Literal[
"DISABLED",
"ENABLED",
]AttributeTypeType#
# AttributeTypeType usage example
from mypy_boto3_qbusiness.literals import AttributeTypeType
def get_value() -> AttributeTypeType:
return "DATE"# AttributeTypeType definition
AttributeTypeType = Literal[
"DATE",
"NUMBER",
"STRING",
"STRING_LIST",
]AttributeValueOperatorType#
# AttributeValueOperatorType usage example
from mypy_boto3_qbusiness.literals import AttributeValueOperatorType
def get_value() -> AttributeValueOperatorType:
return "DELETE"# AttributeValueOperatorType definition
AttributeValueOperatorType = Literal[
"DELETE",
]AutoSubscriptionStatusType#
# AutoSubscriptionStatusType usage example
from mypy_boto3_qbusiness.literals import AutoSubscriptionStatusType
def get_value() -> AutoSubscriptionStatusType:
return "DISABLED"# AutoSubscriptionStatusType definition
AutoSubscriptionStatusType = Literal[
"DISABLED",
"ENABLED",
]ChatModeType#
# ChatModeType usage example
from mypy_boto3_qbusiness.literals import ChatModeType
def get_value() -> ChatModeType:
return "CREATOR_MODE"# ChatModeType definition
ChatModeType = Literal[
"CREATOR_MODE",
"PLUGIN_MODE",
"RETRIEVAL_MODE",
]ContentTypeType#
# ContentTypeType usage example
from mypy_boto3_qbusiness.literals import ContentTypeType
def get_value() -> ContentTypeType:
return "CSV"# ContentTypeType definition
ContentTypeType = Literal[
"CSV",
"HTML",
"JSON",
"MD",
"MS_EXCEL",
"MS_WORD",
"PDF",
"PLAIN_TEXT",
"PPT",
"RTF",
"XML",
"XSLT",
]CreatorModeControlType#
# CreatorModeControlType usage example
from mypy_boto3_qbusiness.literals import CreatorModeControlType
def get_value() -> CreatorModeControlType:
return "DISABLED"# CreatorModeControlType definition
CreatorModeControlType = Literal[
"DISABLED",
"ENABLED",
]DataSourceStatusType#
# DataSourceStatusType usage example
from mypy_boto3_qbusiness.literals import DataSourceStatusType
def get_value() -> DataSourceStatusType:
return "ACTIVE"# DataSourceStatusType definition
DataSourceStatusType = Literal[
"ACTIVE",
"CREATING",
"DELETING",
"FAILED",
"PENDING_CREATION",
"UPDATING",
]DataSourceSyncJobStatusType#
# DataSourceSyncJobStatusType usage example
from mypy_boto3_qbusiness.literals import DataSourceSyncJobStatusType
def get_value() -> DataSourceSyncJobStatusType:
return "ABORTED"# DataSourceSyncJobStatusType definition
DataSourceSyncJobStatusType = Literal[
"ABORTED",
"FAILED",
"INCOMPLETE",
"STOPPING",
"SUCCEEDED",
"SYNCING",
"SYNCING_INDEXING",
]DocumentAttributeBoostingLevelType#
# DocumentAttributeBoostingLevelType usage example
from mypy_boto3_qbusiness.literals import DocumentAttributeBoostingLevelType
def get_value() -> DocumentAttributeBoostingLevelType:
return "HIGH"# DocumentAttributeBoostingLevelType definition
DocumentAttributeBoostingLevelType = Literal[
"HIGH",
"LOW",
"MEDIUM",
"NONE",
"VERY_HIGH",
]DocumentContentOperatorType#
# DocumentContentOperatorType usage example
from mypy_boto3_qbusiness.literals import DocumentContentOperatorType
def get_value() -> DocumentContentOperatorType:
return "DELETE"# DocumentContentOperatorType definition
DocumentContentOperatorType = Literal[
"DELETE",
]DocumentEnrichmentConditionOperatorType#
# DocumentEnrichmentConditionOperatorType usage example
from mypy_boto3_qbusiness.literals import DocumentEnrichmentConditionOperatorType
def get_value() -> DocumentEnrichmentConditionOperatorType:
return "BEGINS_WITH"# DocumentEnrichmentConditionOperatorType definition
DocumentEnrichmentConditionOperatorType = Literal[
"BEGINS_WITH",
"CONTAINS",
"EQUALS",
"EXISTS",
"GREATER_THAN",
"GREATER_THAN_OR_EQUALS",
"LESS_THAN",
"LESS_THAN_OR_EQUALS",
"NOT_CONTAINS",
"NOT_EQUALS",
"NOT_EXISTS",
]DocumentStatusType#
# DocumentStatusType usage example
from mypy_boto3_qbusiness.literals import DocumentStatusType
def get_value() -> DocumentStatusType:
return "DELETED"# DocumentStatusType definition
DocumentStatusType = Literal[
"DELETED",
"DELETING",
"DOCUMENT_FAILED_TO_INDEX",
"FAILED",
"INDEXED",
"PROCESSING",
"RECEIVED",
"UPDATED",
]ErrorCodeType#
# ErrorCodeType usage example
from mypy_boto3_qbusiness.literals import ErrorCodeType
def get_value() -> ErrorCodeType:
return "InternalError"# ErrorCodeType definition
ErrorCodeType = Literal[
"InternalError",
"InvalidRequest",
"ResourceInactive",
"ResourceNotFound",
]GetChatControlsConfigurationPaginatorName#
# GetChatControlsConfigurationPaginatorName usage example
from mypy_boto3_qbusiness.literals import GetChatControlsConfigurationPaginatorName
def get_value() -> GetChatControlsConfigurationPaginatorName:
return "get_chat_controls_configuration"# GetChatControlsConfigurationPaginatorName definition
GetChatControlsConfigurationPaginatorName = Literal[
"get_chat_controls_configuration",
]GroupStatusType#
# GroupStatusType usage example
from mypy_boto3_qbusiness.literals import GroupStatusType
def get_value() -> GroupStatusType:
return "DELETED"# GroupStatusType definition
GroupStatusType = Literal[
"DELETED",
"DELETING",
"FAILED",
"PROCESSING",
"SUCCEEDED",
]IdentityTypeType#
# IdentityTypeType usage example
from mypy_boto3_qbusiness.literals import IdentityTypeType
def get_value() -> IdentityTypeType:
return "AWS_IAM_IDC"# IdentityTypeType definition
IdentityTypeType = Literal[
"AWS_IAM_IDC",
"AWS_IAM_IDP_OIDC",
"AWS_IAM_IDP_SAML",
]IndexStatusType#
# IndexStatusType usage example
from mypy_boto3_qbusiness.literals import IndexStatusType
def get_value() -> IndexStatusType:
return "ACTIVE"# IndexStatusType definition
IndexStatusType = Literal[
"ACTIVE",
"CREATING",
"DELETING",
"FAILED",
"UPDATING",
]IndexTypeType#
# IndexTypeType usage example
from mypy_boto3_qbusiness.literals import IndexTypeType
def get_value() -> IndexTypeType:
return "ENTERPRISE"# IndexTypeType definition
IndexTypeType = Literal[
"ENTERPRISE",
"STARTER",
]ListApplicationsPaginatorName#
# ListApplicationsPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListApplicationsPaginatorName
def get_value() -> ListApplicationsPaginatorName:
return "list_applications"# ListApplicationsPaginatorName definition
ListApplicationsPaginatorName = Literal[
"list_applications",
]ListConversationsPaginatorName#
# ListConversationsPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListConversationsPaginatorName
def get_value() -> ListConversationsPaginatorName:
return "list_conversations"# ListConversationsPaginatorName definition
ListConversationsPaginatorName = Literal[
"list_conversations",
]ListDataSourceSyncJobsPaginatorName#
# ListDataSourceSyncJobsPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListDataSourceSyncJobsPaginatorName
def get_value() -> ListDataSourceSyncJobsPaginatorName:
return "list_data_source_sync_jobs"# ListDataSourceSyncJobsPaginatorName definition
ListDataSourceSyncJobsPaginatorName = Literal[
"list_data_source_sync_jobs",
]ListDataSourcesPaginatorName#
# ListDataSourcesPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListDataSourcesPaginatorName
def get_value() -> ListDataSourcesPaginatorName:
return "list_data_sources"# ListDataSourcesPaginatorName definition
ListDataSourcesPaginatorName = Literal[
"list_data_sources",
]ListDocumentsPaginatorName#
# ListDocumentsPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListDocumentsPaginatorName
def get_value() -> ListDocumentsPaginatorName:
return "list_documents"# ListDocumentsPaginatorName definition
ListDocumentsPaginatorName = Literal[
"list_documents",
]ListGroupsPaginatorName#
# ListGroupsPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListGroupsPaginatorName
def get_value() -> ListGroupsPaginatorName:
return "list_groups"# ListGroupsPaginatorName definition
ListGroupsPaginatorName = Literal[
"list_groups",
]ListIndicesPaginatorName#
# ListIndicesPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListIndicesPaginatorName
def get_value() -> ListIndicesPaginatorName:
return "list_indices"# ListIndicesPaginatorName definition
ListIndicesPaginatorName = Literal[
"list_indices",
]ListMessagesPaginatorName#
# ListMessagesPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListMessagesPaginatorName
def get_value() -> ListMessagesPaginatorName:
return "list_messages"# ListMessagesPaginatorName definition
ListMessagesPaginatorName = Literal[
"list_messages",
]ListPluginsPaginatorName#
# ListPluginsPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListPluginsPaginatorName
def get_value() -> ListPluginsPaginatorName:
return "list_plugins"# ListPluginsPaginatorName definition
ListPluginsPaginatorName = Literal[
"list_plugins",
]ListRetrieversPaginatorName#
# ListRetrieversPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListRetrieversPaginatorName
def get_value() -> ListRetrieversPaginatorName:
return "list_retrievers"# ListRetrieversPaginatorName definition
ListRetrieversPaginatorName = Literal[
"list_retrievers",
]ListWebExperiencesPaginatorName#
# ListWebExperiencesPaginatorName usage example
from mypy_boto3_qbusiness.literals import ListWebExperiencesPaginatorName
def get_value() -> ListWebExperiencesPaginatorName:
return "list_web_experiences"# ListWebExperiencesPaginatorName definition
ListWebExperiencesPaginatorName = Literal[
"list_web_experiences",
]MemberRelationType#
# MemberRelationType usage example
from mypy_boto3_qbusiness.literals import MemberRelationType
def get_value() -> MemberRelationType:
return "AND"# MemberRelationType definition
MemberRelationType = Literal[
"AND",
"OR",
]MembershipTypeType#
# MembershipTypeType usage example
from mypy_boto3_qbusiness.literals import MembershipTypeType
def get_value() -> MembershipTypeType:
return "DATASOURCE"# MembershipTypeType definition
MembershipTypeType = Literal[
"DATASOURCE",
"INDEX",
]MessageTypeType#
# MessageTypeType usage example
from mypy_boto3_qbusiness.literals import MessageTypeType
def get_value() -> MessageTypeType:
return "SYSTEM"# MessageTypeType definition
MessageTypeType = Literal[
"SYSTEM",
"USER",
]MessageUsefulnessReasonType#
# MessageUsefulnessReasonType usage example
from mypy_boto3_qbusiness.literals import MessageUsefulnessReasonType
def get_value() -> MessageUsefulnessReasonType:
return "COMPLETE"# MessageUsefulnessReasonType definition
MessageUsefulnessReasonType = Literal[
"COMPLETE",
"FACTUALLY_CORRECT",
"HARMFUL_OR_UNSAFE",
"HELPFUL",
"INCORRECT_OR_MISSING_SOURCES",
"NOT_BASED_ON_DOCUMENTS",
"NOT_COMPLETE",
"NOT_CONCISE",
"NOT_FACTUALLY_CORRECT",
"NOT_HELPFUL",
"OTHER",
"RELEVANT_SOURCES",
]MessageUsefulnessType#
# MessageUsefulnessType usage example
from mypy_boto3_qbusiness.literals import MessageUsefulnessType
def get_value() -> MessageUsefulnessType:
return "NOT_USEFUL"# MessageUsefulnessType definition
MessageUsefulnessType = Literal[
"NOT_USEFUL",
"USEFUL",
]NumberAttributeBoostingTypeType#
# NumberAttributeBoostingTypeType usage example
from mypy_boto3_qbusiness.literals import NumberAttributeBoostingTypeType
def get_value() -> NumberAttributeBoostingTypeType:
return "PRIORITIZE_LARGER_VALUES"# NumberAttributeBoostingTypeType definition
NumberAttributeBoostingTypeType = Literal[
"PRIORITIZE_LARGER_VALUES",
"PRIORITIZE_SMALLER_VALUES",
]PersonalizationControlModeType#
# PersonalizationControlModeType usage example
from mypy_boto3_qbusiness.literals import PersonalizationControlModeType
def get_value() -> PersonalizationControlModeType:
return "DISABLED"# PersonalizationControlModeType definition
PersonalizationControlModeType = Literal[
"DISABLED",
"ENABLED",
]PluginBuildStatusType#
# PluginBuildStatusType usage example
from mypy_boto3_qbusiness.literals import PluginBuildStatusType
def get_value() -> PluginBuildStatusType:
return "CREATE_FAILED"# PluginBuildStatusType definition
PluginBuildStatusType = Literal[
"CREATE_FAILED",
"CREATE_IN_PROGRESS",
"DELETE_FAILED",
"DELETE_IN_PROGRESS",
"READY",
"UPDATE_FAILED",
"UPDATE_IN_PROGRESS",
]PluginStateType#
# PluginStateType usage example
from mypy_boto3_qbusiness.literals import PluginStateType
def get_value() -> PluginStateType:
return "DISABLED"# PluginStateType definition
PluginStateType = Literal[
"DISABLED",
"ENABLED",
]PluginTypeType#
# PluginTypeType usage example
from mypy_boto3_qbusiness.literals import PluginTypeType
def get_value() -> PluginTypeType:
return "CUSTOM"# PluginTypeType definition
PluginTypeType = Literal[
"CUSTOM",
"JIRA",
"SALESFORCE",
"SERVICE_NOW",
"ZENDESK",
]QAppsControlModeType#
# QAppsControlModeType usage example
from mypy_boto3_qbusiness.literals import QAppsControlModeType
def get_value() -> QAppsControlModeType:
return "DISABLED"# QAppsControlModeType definition
QAppsControlModeType = Literal[
"DISABLED",
"ENABLED",
]ReadAccessTypeType#
# ReadAccessTypeType usage example
from mypy_boto3_qbusiness.literals import ReadAccessTypeType
def get_value() -> ReadAccessTypeType:
return "ALLOW"# ReadAccessTypeType definition
ReadAccessTypeType = Literal[
"ALLOW",
"DENY",
]