Type definitions#
Auto-generated documentation for QBusiness type annotations stubs module types-boto3-qbusiness.
BlobTypeDef#
# BlobTypeDef Union usage example
from types_boto3_qbusiness.type_defs import BlobTypeDef
def get_value() -> BlobTypeDef:
return ...
# BlobTypeDef definition
BlobTypeDef = Union[
str,
bytes,
IO[Any],
StreamingBody,
]TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_qbusiness.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]ActionExecutionPayloadFieldUnionTypeDef#
# ActionExecutionPayloadFieldUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import ActionExecutionPayloadFieldUnionTypeDef
def get_value() -> ActionExecutionPayloadFieldUnionTypeDef:
return ...
# ActionExecutionPayloadFieldUnionTypeDef definition
ActionExecutionPayloadFieldUnionTypeDef = Union[
ActionExecutionPayloadFieldTypeDef, # (1)
ActionExecutionPayloadFieldOutputTypeDef, # (2)
]BrowserExtensionConfigurationUnionTypeDef#
# BrowserExtensionConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import BrowserExtensionConfigurationUnionTypeDef
def get_value() -> BrowserExtensionConfigurationUnionTypeDef:
return ...
# BrowserExtensionConfigurationUnionTypeDef definition
BrowserExtensionConfigurationUnionTypeDef = Union[
BrowserExtensionConfigurationTypeDef, # (1)
BrowserExtensionConfigurationOutputTypeDef, # (2)
]DataSourceVpcConfigurationUnionTypeDef#
# DataSourceVpcConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import DataSourceVpcConfigurationUnionTypeDef
def get_value() -> DataSourceVpcConfigurationUnionTypeDef:
return ...
# DataSourceVpcConfigurationUnionTypeDef definition
DataSourceVpcConfigurationUnionTypeDef = Union[
DataSourceVpcConfigurationTypeDef, # (1)
DataSourceVpcConfigurationOutputTypeDef, # (2)
]UsersAndGroupsUnionTypeDef#
# UsersAndGroupsUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import UsersAndGroupsUnionTypeDef
def get_value() -> UsersAndGroupsUnionTypeDef:
return ...
# UsersAndGroupsUnionTypeDef definition
UsersAndGroupsUnionTypeDef = Union[
UsersAndGroupsTypeDef, # (1)
UsersAndGroupsOutputTypeDef, # (2)
]ActionExecutionUnionTypeDef#
# ActionExecutionUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import ActionExecutionUnionTypeDef
def get_value() -> ActionExecutionUnionTypeDef:
return ...
# ActionExecutionUnionTypeDef definition
ActionExecutionUnionTypeDef = Union[
ActionExecutionTypeDef, # (1)
ActionExecutionOutputTypeDef, # (2)
]ContentRetrievalRuleUnionTypeDef#
# ContentRetrievalRuleUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import ContentRetrievalRuleUnionTypeDef
def get_value() -> ContentRetrievalRuleUnionTypeDef:
return ...
# ContentRetrievalRuleUnionTypeDef definition
ContentRetrievalRuleUnionTypeDef = Union[
ContentRetrievalRuleTypeDef, # (1)
ContentRetrievalRuleOutputTypeDef, # (2)
]DocumentAttributeValueUnionTypeDef#
# DocumentAttributeValueUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeValueUnionTypeDef
def get_value() -> DocumentAttributeValueUnionTypeDef:
return ...
# DocumentAttributeValueUnionTypeDef definition
DocumentAttributeValueUnionTypeDef = Union[
DocumentAttributeValueTypeDef, # (1)
DocumentAttributeValueOutputTypeDef, # (2)
]PluginAuthConfigurationUnionTypeDef#
# PluginAuthConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import PluginAuthConfigurationUnionTypeDef
def get_value() -> PluginAuthConfigurationUnionTypeDef:
return ...
# PluginAuthConfigurationUnionTypeDef definition
PluginAuthConfigurationUnionTypeDef = Union[
PluginAuthConfigurationTypeDef, # (1)
PluginAuthConfigurationOutputTypeDef, # (2)
]RuleConfigurationUnionTypeDef#
# RuleConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import RuleConfigurationUnionTypeDef
def get_value() -> RuleConfigurationUnionTypeDef:
return ...
# RuleConfigurationUnionTypeDef definition
RuleConfigurationUnionTypeDef = Union[
RuleConfigurationTypeDef, # (1)
RuleConfigurationOutputTypeDef, # (2)
]RetrieverConfigurationUnionTypeDef#
# RetrieverConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import RetrieverConfigurationUnionTypeDef
def get_value() -> RetrieverConfigurationUnionTypeDef:
return ...
# RetrieverConfigurationUnionTypeDef definition
RetrieverConfigurationUnionTypeDef = Union[
RetrieverConfigurationTypeDef, # (1)
RetrieverConfigurationOutputTypeDef, # (2)
]DocumentAttributeConditionUnionTypeDef#
# DocumentAttributeConditionUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeConditionUnionTypeDef
def get_value() -> DocumentAttributeConditionUnionTypeDef:
return ...
# DocumentAttributeConditionUnionTypeDef definition
DocumentAttributeConditionUnionTypeDef = Union[
DocumentAttributeConditionTypeDef, # (1)
DocumentAttributeConditionOutputTypeDef, # (2)
]DocumentAttributeTargetUnionTypeDef#
# DocumentAttributeTargetUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeTargetUnionTypeDef
def get_value() -> DocumentAttributeTargetUnionTypeDef:
return ...
# DocumentAttributeTargetUnionTypeDef definition
DocumentAttributeTargetUnionTypeDef = Union[
DocumentAttributeTargetTypeDef, # (1)
DocumentAttributeTargetOutputTypeDef, # (2)
]DocumentAttributeUnionTypeDef#
# DocumentAttributeUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeUnionTypeDef
def get_value() -> DocumentAttributeUnionTypeDef:
return ...
# DocumentAttributeUnionTypeDef definition
DocumentAttributeUnionTypeDef = Union[
DocumentAttributeTypeDef, # (1)
DocumentAttributeOutputTypeDef, # (2)
]RuleUnionTypeDef#
# RuleUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import RuleUnionTypeDef
def get_value() -> RuleUnionTypeDef:
return ...
# RuleUnionTypeDef definition
RuleUnionTypeDef = Union[
RuleTypeDef, # (1)
RuleOutputTypeDef, # (2)
]- See RuleTypeDef
- See RuleOutputTypeDef
HookConfigurationUnionTypeDef#
# HookConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import HookConfigurationUnionTypeDef
def get_value() -> HookConfigurationUnionTypeDef:
return ...
# HookConfigurationUnionTypeDef definition
HookConfigurationUnionTypeDef = Union[
HookConfigurationTypeDef, # (1)
HookConfigurationOutputTypeDef, # (2)
]InlineDocumentEnrichmentConfigurationUnionTypeDef#
# InlineDocumentEnrichmentConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import InlineDocumentEnrichmentConfigurationUnionTypeDef
def get_value() -> InlineDocumentEnrichmentConfigurationUnionTypeDef:
return ...
# InlineDocumentEnrichmentConfigurationUnionTypeDef definition
InlineDocumentEnrichmentConfigurationUnionTypeDef = Union[
InlineDocumentEnrichmentConfigurationTypeDef, # (1)
InlineDocumentEnrichmentConfigurationOutputTypeDef, # (2)
]- See InlineDocumentEnrichmentConfigurationTypeDef
- See InlineDocumentEnrichmentConfigurationOutputTypeDef
AttributeFilterUnionTypeDef#
# AttributeFilterUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import AttributeFilterUnionTypeDef
def get_value() -> AttributeFilterUnionTypeDef:
return ...
# AttributeFilterUnionTypeDef definition
AttributeFilterUnionTypeDef = Union[
AttributeFilterTypeDef, # (1)
AttributeFilterOutputTypeDef, # (2)
]TopicConfigurationUnionTypeDef#
# TopicConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import TopicConfigurationUnionTypeDef
def get_value() -> TopicConfigurationUnionTypeDef:
return ...
# TopicConfigurationUnionTypeDef definition
TopicConfigurationUnionTypeDef = Union[
TopicConfigurationTypeDef, # (1)
TopicConfigurationOutputTypeDef, # (2)
]DocumentEnrichmentConfigurationUnionTypeDef#
# DocumentEnrichmentConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import DocumentEnrichmentConfigurationUnionTypeDef
def get_value() -> DocumentEnrichmentConfigurationUnionTypeDef:
return ...
# DocumentEnrichmentConfigurationUnionTypeDef definition
DocumentEnrichmentConfigurationUnionTypeDef = Union[
DocumentEnrichmentConfigurationTypeDef, # (1)
DocumentEnrichmentConfigurationOutputTypeDef, # (2)
]ActionFilterConfigurationUnionTypeDef#
# ActionFilterConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import ActionFilterConfigurationUnionTypeDef
def get_value() -> ActionFilterConfigurationUnionTypeDef:
return ...
# ActionFilterConfigurationUnionTypeDef definition
ActionFilterConfigurationUnionTypeDef = Union[
ActionFilterConfigurationTypeDef, # (1)
ActionFilterConfigurationOutputTypeDef, # (2)
]ActionConfigurationUnionTypeDef#
# ActionConfigurationUnionTypeDef Union usage example
from types_boto3_qbusiness.type_defs import ActionConfigurationUnionTypeDef
def get_value() -> ActionConfigurationUnionTypeDef:
return ...
# ActionConfigurationUnionTypeDef definition
ActionConfigurationUnionTypeDef = Union[
ActionConfigurationTypeDef, # (1)
ActionConfigurationOutputTypeDef, # (2)
]S3TypeDef#
# S3TypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import S3TypeDef
def get_value() -> S3TypeDef:
return {
"bucket": ...,
}
# S3TypeDef definition
class S3TypeDef(TypedDict):
bucket: str,
key: str,ActionExecutionPayloadFieldOutputTypeDef#
# ActionExecutionPayloadFieldOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionExecutionPayloadFieldOutputTypeDef
def get_value() -> ActionExecutionPayloadFieldOutputTypeDef:
return {
"value": ...,
}
# ActionExecutionPayloadFieldOutputTypeDef definition
class ActionExecutionPayloadFieldOutputTypeDef(TypedDict):
value: Dict[str, Any],ActionExecutionPayloadFieldTypeDef#
# ActionExecutionPayloadFieldTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionExecutionPayloadFieldTypeDef
def get_value() -> ActionExecutionPayloadFieldTypeDef:
return {
"value": ...,
}
# ActionExecutionPayloadFieldTypeDef definition
class ActionExecutionPayloadFieldTypeDef(TypedDict):
value: Mapping[str, Any],ActionReviewPayloadFieldAllowedValueTypeDef#
# ActionReviewPayloadFieldAllowedValueTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionReviewPayloadFieldAllowedValueTypeDef
def get_value() -> ActionReviewPayloadFieldAllowedValueTypeDef:
return {
"value": ...,
}
# ActionReviewPayloadFieldAllowedValueTypeDef definition
class ActionReviewPayloadFieldAllowedValueTypeDef(TypedDict):
value: NotRequired[Dict[str, Any]],
displayValue: NotRequired[Dict[str, Any]],ActionSummaryTypeDef#
# ActionSummaryTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionSummaryTypeDef
def get_value() -> ActionSummaryTypeDef:
return {
"actionIdentifier": ...,
}
# ActionSummaryTypeDef definition
class ActionSummaryTypeDef(TypedDict):
actionIdentifier: NotRequired[str],
displayName: NotRequired[str],
instructionExample: NotRequired[str],
description: NotRequired[str],QuickSightConfigurationTypeDef#
# QuickSightConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import QuickSightConfigurationTypeDef
def get_value() -> QuickSightConfigurationTypeDef:
return {
"clientNamespace": ...,
}
# QuickSightConfigurationTypeDef definition
class QuickSightConfigurationTypeDef(TypedDict):
clientNamespace: str,AppliedAttachmentsConfigurationTypeDef#
# AppliedAttachmentsConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AppliedAttachmentsConfigurationTypeDef
def get_value() -> AppliedAttachmentsConfigurationTypeDef:
return {
"attachmentsControlMode": ...,
}
# AppliedAttachmentsConfigurationTypeDef definition
class AppliedAttachmentsConfigurationTypeDef(TypedDict):
attachmentsControlMode: NotRequired[AttachmentsControlModeType], # (1)AppliedCreatorModeConfigurationTypeDef#
# AppliedCreatorModeConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AppliedCreatorModeConfigurationTypeDef
def get_value() -> AppliedCreatorModeConfigurationTypeDef:
return {
"creatorModeControl": ...,
}
# AppliedCreatorModeConfigurationTypeDef definition
class AppliedCreatorModeConfigurationTypeDef(TypedDict):
creatorModeControl: CreatorModeControlType, # (1)AppliedOrchestrationConfigurationTypeDef#
# AppliedOrchestrationConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AppliedOrchestrationConfigurationTypeDef
def get_value() -> AppliedOrchestrationConfigurationTypeDef:
return {
"control": ...,
}
# AppliedOrchestrationConfigurationTypeDef definition
class AppliedOrchestrationConfigurationTypeDef(TypedDict):
control: OrchestrationControlType, # (1)AssociatePermissionRequestTypeDef#
# AssociatePermissionRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AssociatePermissionRequestTypeDef
def get_value() -> AssociatePermissionRequestTypeDef:
return {
"applicationId": ...,
}
# AssociatePermissionRequestTypeDef definition
class AssociatePermissionRequestTypeDef(TypedDict):
applicationId: str,
statementId: str,
actions: Sequence[str],
principal: str,ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],ErrorDetailTypeDef#
# ErrorDetailTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ErrorDetailTypeDef
def get_value() -> ErrorDetailTypeDef:
return {
"errorMessage": ...,
}
# ErrorDetailTypeDef definition
class ErrorDetailTypeDef(TypedDict):
errorMessage: NotRequired[str],
errorCode: NotRequired[ErrorCodeType], # (1)- See ErrorCodeType
AttachmentsConfigurationTypeDef#
# AttachmentsConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttachmentsConfigurationTypeDef
def get_value() -> AttachmentsConfigurationTypeDef:
return {
"attachmentsControlMode": ...,
}
# AttachmentsConfigurationTypeDef definition
class AttachmentsConfigurationTypeDef(TypedDict):
attachmentsControlMode: AttachmentsControlModeType, # (1)AuthChallengeRequestEventTypeDef#
# AuthChallengeRequestEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AuthChallengeRequestEventTypeDef
def get_value() -> AuthChallengeRequestEventTypeDef:
return {
"authorizationUrl": ...,
}
# AuthChallengeRequestEventTypeDef definition
class AuthChallengeRequestEventTypeDef(TypedDict):
authorizationUrl: str,AuthChallengeRequestTypeDef#
# AuthChallengeRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AuthChallengeRequestTypeDef
def get_value() -> AuthChallengeRequestTypeDef:
return {
"authorizationUrl": ...,
}
# AuthChallengeRequestTypeDef definition
class AuthChallengeRequestTypeDef(TypedDict):
authorizationUrl: str,AuthChallengeResponseEventTypeDef#
# AuthChallengeResponseEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AuthChallengeResponseEventTypeDef
def get_value() -> AuthChallengeResponseEventTypeDef:
return {
"responseMap": ...,
}
# AuthChallengeResponseEventTypeDef definition
class AuthChallengeResponseEventTypeDef(TypedDict):
responseMap: Mapping[str, str],AuthChallengeResponseTypeDef#
# AuthChallengeResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AuthChallengeResponseTypeDef
def get_value() -> AuthChallengeResponseTypeDef:
return {
"responseMap": ...,
}
# AuthChallengeResponseTypeDef definition
class AuthChallengeResponseTypeDef(TypedDict):
responseMap: Mapping[str, str],AutoSubscriptionConfigurationTypeDef#
# AutoSubscriptionConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AutoSubscriptionConfigurationTypeDef
def get_value() -> AutoSubscriptionConfigurationTypeDef:
return {
"autoSubscribe": ...,
}
# AutoSubscriptionConfigurationTypeDef definition
class AutoSubscriptionConfigurationTypeDef(TypedDict):
autoSubscribe: AutoSubscriptionStatusType, # (1)
defaultSubscriptionType: NotRequired[SubscriptionTypeType], # (2)BasicAuthConfigurationTypeDef#
# BasicAuthConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BasicAuthConfigurationTypeDef
def get_value() -> BasicAuthConfigurationTypeDef:
return {
"secretArn": ...,
}
# BasicAuthConfigurationTypeDef definition
class BasicAuthConfigurationTypeDef(TypedDict):
secretArn: str,
roleArn: str,DeleteDocumentTypeDef#
# DeleteDocumentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteDocumentTypeDef
def get_value() -> DeleteDocumentTypeDef:
return {
"documentId": ...,
}
# DeleteDocumentTypeDef definition
class DeleteDocumentTypeDef(TypedDict):
documentId: str,BlockedPhrasesConfigurationTypeDef#
# BlockedPhrasesConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BlockedPhrasesConfigurationTypeDef
def get_value() -> BlockedPhrasesConfigurationTypeDef:
return {
"blockedPhrases": ...,
}
# BlockedPhrasesConfigurationTypeDef definition
class BlockedPhrasesConfigurationTypeDef(TypedDict):
blockedPhrases: NotRequired[List[str]],
systemMessageOverride: NotRequired[str],BlockedPhrasesConfigurationUpdateTypeDef#
# BlockedPhrasesConfigurationUpdateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BlockedPhrasesConfigurationUpdateTypeDef
def get_value() -> BlockedPhrasesConfigurationUpdateTypeDef:
return {
"blockedPhrasesToCreateOrUpdate": ...,
}
# BlockedPhrasesConfigurationUpdateTypeDef definition
class BlockedPhrasesConfigurationUpdateTypeDef(TypedDict):
blockedPhrasesToCreateOrUpdate: NotRequired[Sequence[str]],
blockedPhrasesToDelete: NotRequired[Sequence[str]],
systemMessageOverride: NotRequired[str],BrowserExtensionConfigurationOutputTypeDef#
# BrowserExtensionConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BrowserExtensionConfigurationOutputTypeDef
def get_value() -> BrowserExtensionConfigurationOutputTypeDef:
return {
"enabledBrowserExtensions": ...,
}
# BrowserExtensionConfigurationOutputTypeDef definition
class BrowserExtensionConfigurationOutputTypeDef(TypedDict):
enabledBrowserExtensions: List[BrowserExtensionType], # (1)BrowserExtensionConfigurationTypeDef#
# BrowserExtensionConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BrowserExtensionConfigurationTypeDef
def get_value() -> BrowserExtensionConfigurationTypeDef:
return {
"enabledBrowserExtensions": ...,
}
# BrowserExtensionConfigurationTypeDef definition
class BrowserExtensionConfigurationTypeDef(TypedDict):
enabledBrowserExtensions: Sequence[BrowserExtensionType], # (1)CancelSubscriptionRequestTypeDef#
# CancelSubscriptionRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CancelSubscriptionRequestTypeDef
def get_value() -> CancelSubscriptionRequestTypeDef:
return {
"applicationId": ...,
}
# CancelSubscriptionRequestTypeDef definition
class CancelSubscriptionRequestTypeDef(TypedDict):
applicationId: str,
subscriptionId: str,SubscriptionDetailsTypeDef#
# SubscriptionDetailsTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SubscriptionDetailsTypeDef
def get_value() -> SubscriptionDetailsTypeDef:
return {
"type": ...,
}
# SubscriptionDetailsTypeDef definition
class SubscriptionDetailsTypeDef(TypedDict):
type: NotRequired[SubscriptionTypeType], # (1)TextInputEventTypeDef#
# TextInputEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TextInputEventTypeDef
def get_value() -> TextInputEventTypeDef:
return {
"userMessage": ...,
}
# TextInputEventTypeDef definition
class TextInputEventTypeDef(TypedDict):
userMessage: str,PluginConfigurationTypeDef#
# PluginConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PluginConfigurationTypeDef
def get_value() -> PluginConfigurationTypeDef:
return {
"pluginId": ...,
}
# PluginConfigurationTypeDef definition
class PluginConfigurationTypeDef(TypedDict):
pluginId: str,TextOutputEventTypeDef#
# TextOutputEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TextOutputEventTypeDef
def get_value() -> TextOutputEventTypeDef:
return {
"conversationId": ...,
}
# TextOutputEventTypeDef definition
class TextOutputEventTypeDef(TypedDict):
conversationId: NotRequired[str],
userMessageId: NotRequired[str],
systemMessageId: NotRequired[str],
systemMessage: NotRequired[str],ContentBlockerRuleTypeDef#
# ContentBlockerRuleTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ContentBlockerRuleTypeDef
def get_value() -> ContentBlockerRuleTypeDef:
return {
"systemMessageOverride": ...,
}
# ContentBlockerRuleTypeDef definition
class ContentBlockerRuleTypeDef(TypedDict):
systemMessageOverride: NotRequired[str],EligibleDataSourceTypeDef#
# EligibleDataSourceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import EligibleDataSourceTypeDef
def get_value() -> EligibleDataSourceTypeDef:
return {
"indexId": ...,
}
# EligibleDataSourceTypeDef definition
class EligibleDataSourceTypeDef(TypedDict):
indexId: NotRequired[str],
dataSourceId: NotRequired[str],RetrieverContentSourceTypeDef#
# RetrieverContentSourceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RetrieverContentSourceTypeDef
def get_value() -> RetrieverContentSourceTypeDef:
return {
"retrieverId": ...,
}
# RetrieverContentSourceTypeDef definition
class RetrieverContentSourceTypeDef(TypedDict):
retrieverId: str,ConversationSourceTypeDef#
# ConversationSourceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ConversationSourceTypeDef
def get_value() -> ConversationSourceTypeDef:
return {
"conversationId": ...,
}
# ConversationSourceTypeDef definition
class ConversationSourceTypeDef(TypedDict):
conversationId: str,
attachmentId: str,ConversationTypeDef#
# ConversationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ConversationTypeDef
def get_value() -> ConversationTypeDef:
return {
"conversationId": ...,
}
# ConversationTypeDef definition
class ConversationTypeDef(TypedDict):
conversationId: NotRequired[str],
title: NotRequired[str],
startTime: NotRequired[datetime],EncryptionConfigurationTypeDef#
# EncryptionConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import EncryptionConfigurationTypeDef
def get_value() -> EncryptionConfigurationTypeDef:
return {
"kmsKeyId": ...,
}
# EncryptionConfigurationTypeDef definition
class EncryptionConfigurationTypeDef(TypedDict):
kmsKeyId: NotRequired[str],PersonalizationConfigurationTypeDef#
# PersonalizationConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PersonalizationConfigurationTypeDef
def get_value() -> PersonalizationConfigurationTypeDef:
return {
"personalizationControlMode": ...,
}
# PersonalizationConfigurationTypeDef definition
class PersonalizationConfigurationTypeDef(TypedDict):
personalizationControlMode: PersonalizationControlModeType, # (1)QAppsConfigurationTypeDef#
# QAppsConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import QAppsConfigurationTypeDef
def get_value() -> QAppsConfigurationTypeDef:
return {
"qAppsControlMode": ...,
}
# QAppsConfigurationTypeDef definition
class QAppsConfigurationTypeDef(TypedDict):
qAppsControlMode: QAppsControlModeType, # (1)TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
key: str,
value: str,IndexCapacityConfigurationTypeDef#
# IndexCapacityConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import IndexCapacityConfigurationTypeDef
def get_value() -> IndexCapacityConfigurationTypeDef:
return {
"units": ...,
}
# IndexCapacityConfigurationTypeDef definition
class IndexCapacityConfigurationTypeDef(TypedDict):
units: NotRequired[int],SubscriptionPrincipalTypeDef#
# SubscriptionPrincipalTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SubscriptionPrincipalTypeDef
def get_value() -> SubscriptionPrincipalTypeDef:
return {
"user": ...,
}
# SubscriptionPrincipalTypeDef definition
class SubscriptionPrincipalTypeDef(TypedDict):
user: NotRequired[str],
group: NotRequired[str],UserAliasTypeDef#
# UserAliasTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UserAliasTypeDef
def get_value() -> UserAliasTypeDef:
return {
"indexId": ...,
}
# UserAliasTypeDef definition
class UserAliasTypeDef(TypedDict):
userId: str,
indexId: NotRequired[str],
dataSourceId: NotRequired[str],CustomizationConfigurationTypeDef#
# CustomizationConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CustomizationConfigurationTypeDef
def get_value() -> CustomizationConfigurationTypeDef:
return {
"customCSSUrl": ...,
}
# CustomizationConfigurationTypeDef definition
class CustomizationConfigurationTypeDef(TypedDict):
customCSSUrl: NotRequired[str],
logoUrl: NotRequired[str],
fontUrl: NotRequired[str],
faviconUrl: NotRequired[str],CreatorModeConfigurationTypeDef#
# CreatorModeConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreatorModeConfigurationTypeDef
def get_value() -> CreatorModeConfigurationTypeDef:
return {
"creatorModeControl": ...,
}
# CreatorModeConfigurationTypeDef definition
class CreatorModeConfigurationTypeDef(TypedDict):
creatorModeControl: CreatorModeControlType, # (1)DataAccessorTypeDef#
# DataAccessorTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DataAccessorTypeDef
def get_value() -> DataAccessorTypeDef:
return {
"displayName": ...,
}
# DataAccessorTypeDef definition
class DataAccessorTypeDef(TypedDict):
displayName: NotRequired[str],
dataAccessorId: NotRequired[str],
dataAccessorArn: NotRequired[str],
idcApplicationArn: NotRequired[str],
principal: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],DataSourceSyncJobMetricsTypeDef#
# DataSourceSyncJobMetricsTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DataSourceSyncJobMetricsTypeDef
def get_value() -> DataSourceSyncJobMetricsTypeDef:
return {
"documentsAdded": ...,
}
# DataSourceSyncJobMetricsTypeDef definition
class DataSourceSyncJobMetricsTypeDef(TypedDict):
documentsAdded: NotRequired[str],
documentsModified: NotRequired[str],
documentsDeleted: NotRequired[str],
documentsFailed: NotRequired[str],
documentsScanned: NotRequired[str],DataSourceTypeDef#
# DataSourceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DataSourceTypeDef
def get_value() -> DataSourceTypeDef:
return {
"displayName": ...,
}
# DataSourceTypeDef definition
class DataSourceTypeDef(TypedDict):
displayName: NotRequired[str],
dataSourceId: NotRequired[str],
type: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
status: NotRequired[DataSourceStatusType], # (1)DataSourceVpcConfigurationOutputTypeDef#
# DataSourceVpcConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DataSourceVpcConfigurationOutputTypeDef
def get_value() -> DataSourceVpcConfigurationOutputTypeDef:
return {
"subnetIds": ...,
}
# DataSourceVpcConfigurationOutputTypeDef definition
class DataSourceVpcConfigurationOutputTypeDef(TypedDict):
subnetIds: List[str],
securityGroupIds: List[str],DataSourceVpcConfigurationTypeDef#
# DataSourceVpcConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DataSourceVpcConfigurationTypeDef
def get_value() -> DataSourceVpcConfigurationTypeDef:
return {
"subnetIds": ...,
}
# DataSourceVpcConfigurationTypeDef definition
class DataSourceVpcConfigurationTypeDef(TypedDict):
subnetIds: Sequence[str],
securityGroupIds: Sequence[str],DateAttributeBoostingConfigurationTypeDef#
# DateAttributeBoostingConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DateAttributeBoostingConfigurationTypeDef
def get_value() -> DateAttributeBoostingConfigurationTypeDef:
return {
"boostingLevel": ...,
}
# DateAttributeBoostingConfigurationTypeDef definition
class DateAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
boostingDurationInSeconds: NotRequired[int],DeleteApplicationRequestTypeDef#
# DeleteApplicationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteApplicationRequestTypeDef
def get_value() -> DeleteApplicationRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteApplicationRequestTypeDef definition
class DeleteApplicationRequestTypeDef(TypedDict):
applicationId: str,DeleteChatControlsConfigurationRequestTypeDef#
# DeleteChatControlsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteChatControlsConfigurationRequestTypeDef
def get_value() -> DeleteChatControlsConfigurationRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteChatControlsConfigurationRequestTypeDef definition
class DeleteChatControlsConfigurationRequestTypeDef(TypedDict):
applicationId: str,DeleteConversationRequestTypeDef#
# DeleteConversationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteConversationRequestTypeDef
def get_value() -> DeleteConversationRequestTypeDef:
return {
"conversationId": ...,
}
# DeleteConversationRequestTypeDef definition
class DeleteConversationRequestTypeDef(TypedDict):
conversationId: str,
applicationId: str,
userId: NotRequired[str],DeleteDataAccessorRequestTypeDef#
# DeleteDataAccessorRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteDataAccessorRequestTypeDef
def get_value() -> DeleteDataAccessorRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteDataAccessorRequestTypeDef definition
class DeleteDataAccessorRequestTypeDef(TypedDict):
applicationId: str,
dataAccessorId: str,DeleteDataSourceRequestTypeDef#
# DeleteDataSourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteDataSourceRequestTypeDef
def get_value() -> DeleteDataSourceRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteDataSourceRequestTypeDef definition
class DeleteDataSourceRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceId: str,DeleteGroupRequestTypeDef#
# DeleteGroupRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteGroupRequestTypeDef
def get_value() -> DeleteGroupRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteGroupRequestTypeDef definition
class DeleteGroupRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
groupName: str,
dataSourceId: NotRequired[str],DeleteIndexRequestTypeDef#
# DeleteIndexRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteIndexRequestTypeDef
def get_value() -> DeleteIndexRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteIndexRequestTypeDef definition
class DeleteIndexRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,DeletePluginRequestTypeDef#
# DeletePluginRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeletePluginRequestTypeDef
def get_value() -> DeletePluginRequestTypeDef:
return {
"applicationId": ...,
}
# DeletePluginRequestTypeDef definition
class DeletePluginRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,DeleteRetrieverRequestTypeDef#
# DeleteRetrieverRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteRetrieverRequestTypeDef
def get_value() -> DeleteRetrieverRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteRetrieverRequestTypeDef definition
class DeleteRetrieverRequestTypeDef(TypedDict):
applicationId: str,
retrieverId: str,DeleteUserRequestTypeDef#
# DeleteUserRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteUserRequestTypeDef
def get_value() -> DeleteUserRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteUserRequestTypeDef definition
class DeleteUserRequestTypeDef(TypedDict):
applicationId: str,
userId: str,DeleteWebExperienceRequestTypeDef#
# DeleteWebExperienceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DeleteWebExperienceRequestTypeDef
def get_value() -> DeleteWebExperienceRequestTypeDef:
return {
"applicationId": ...,
}
# DeleteWebExperienceRequestTypeDef definition
class DeleteWebExperienceRequestTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,DisassociatePermissionRequestTypeDef#
# DisassociatePermissionRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DisassociatePermissionRequestTypeDef
def get_value() -> DisassociatePermissionRequestTypeDef:
return {
"applicationId": ...,
}
# DisassociatePermissionRequestTypeDef definition
class DisassociatePermissionRequestTypeDef(TypedDict):
applicationId: str,
statementId: str,NumberAttributeBoostingConfigurationTypeDef#
# NumberAttributeBoostingConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import NumberAttributeBoostingConfigurationTypeDef
def get_value() -> NumberAttributeBoostingConfigurationTypeDef:
return {
"boostingLevel": ...,
}
# NumberAttributeBoostingConfigurationTypeDef definition
class NumberAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
boostingType: NotRequired[NumberAttributeBoostingTypeType], # (2)StringAttributeBoostingConfigurationOutputTypeDef#
# StringAttributeBoostingConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import StringAttributeBoostingConfigurationOutputTypeDef
def get_value() -> StringAttributeBoostingConfigurationOutputTypeDef:
return {
"boostingLevel": ...,
}
# StringAttributeBoostingConfigurationOutputTypeDef definition
class StringAttributeBoostingConfigurationOutputTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
attributeValueBoosting: NotRequired[Dict[str, StringAttributeValueBoostingLevelType]], # (2)StringListAttributeBoostingConfigurationTypeDef#
# StringListAttributeBoostingConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import StringListAttributeBoostingConfigurationTypeDef
def get_value() -> StringListAttributeBoostingConfigurationTypeDef:
return {
"boostingLevel": ...,
}
# StringListAttributeBoostingConfigurationTypeDef definition
class StringListAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)StringAttributeBoostingConfigurationTypeDef#
# StringAttributeBoostingConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import StringAttributeBoostingConfigurationTypeDef
def get_value() -> StringAttributeBoostingConfigurationTypeDef:
return {
"boostingLevel": ...,
}
# StringAttributeBoostingConfigurationTypeDef definition
class StringAttributeBoostingConfigurationTypeDef(TypedDict):
boostingLevel: DocumentAttributeBoostingLevelType, # (1)
attributeValueBoosting: NotRequired[Mapping[str, StringAttributeValueBoostingLevelType]], # (2)DocumentAttributeValueOutputTypeDef#
# DocumentAttributeValueOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeValueOutputTypeDef
def get_value() -> DocumentAttributeValueOutputTypeDef:
return {
"stringValue": ...,
}
# DocumentAttributeValueOutputTypeDef definition
class DocumentAttributeValueOutputTypeDef(TypedDict):
stringValue: NotRequired[str],
stringListValue: NotRequired[List[str]],
longValue: NotRequired[int],
dateValue: NotRequired[datetime],DocumentAttributeConfigurationTypeDef#
# DocumentAttributeConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeConfigurationTypeDef
def get_value() -> DocumentAttributeConfigurationTypeDef:
return {
"name": ...,
}
# DocumentAttributeConfigurationTypeDef definition
class DocumentAttributeConfigurationTypeDef(TypedDict):
name: NotRequired[str],
type: NotRequired[AttributeTypeType], # (1)
search: NotRequired[StatusType], # (2)- See AttributeTypeType
- See StatusType
GetApplicationRequestTypeDef#
# GetApplicationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetApplicationRequestTypeDef
def get_value() -> GetApplicationRequestTypeDef:
return {
"applicationId": ...,
}
# GetApplicationRequestTypeDef definition
class GetApplicationRequestTypeDef(TypedDict):
applicationId: str,PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],GetChatControlsConfigurationRequestTypeDef#
# GetChatControlsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetChatControlsConfigurationRequestTypeDef
def get_value() -> GetChatControlsConfigurationRequestTypeDef:
return {
"applicationId": ...,
}
# GetChatControlsConfigurationRequestTypeDef definition
class GetChatControlsConfigurationRequestTypeDef(TypedDict):
applicationId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],GetDataAccessorRequestTypeDef#
# GetDataAccessorRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetDataAccessorRequestTypeDef
def get_value() -> GetDataAccessorRequestTypeDef:
return {
"applicationId": ...,
}
# GetDataAccessorRequestTypeDef definition
class GetDataAccessorRequestTypeDef(TypedDict):
applicationId: str,
dataAccessorId: str,GetDataSourceRequestTypeDef#
# GetDataSourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetDataSourceRequestTypeDef
def get_value() -> GetDataSourceRequestTypeDef:
return {
"applicationId": ...,
}
# GetDataSourceRequestTypeDef definition
class GetDataSourceRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceId: str,GetGroupRequestTypeDef#
# GetGroupRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetGroupRequestTypeDef
def get_value() -> GetGroupRequestTypeDef:
return {
"applicationId": ...,
}
# GetGroupRequestTypeDef definition
class GetGroupRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
groupName: str,
dataSourceId: NotRequired[str],GetIndexRequestTypeDef#
# GetIndexRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetIndexRequestTypeDef
def get_value() -> GetIndexRequestTypeDef:
return {
"applicationId": ...,
}
# GetIndexRequestTypeDef definition
class GetIndexRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,GetMediaRequestTypeDef#
# GetMediaRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetMediaRequestTypeDef
def get_value() -> GetMediaRequestTypeDef:
return {
"applicationId": ...,
}
# GetMediaRequestTypeDef definition
class GetMediaRequestTypeDef(TypedDict):
applicationId: str,
conversationId: str,
messageId: str,
mediaId: str,GetPluginRequestTypeDef#
# GetPluginRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetPluginRequestTypeDef
def get_value() -> GetPluginRequestTypeDef:
return {
"applicationId": ...,
}
# GetPluginRequestTypeDef definition
class GetPluginRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,GetPolicyRequestTypeDef#
# GetPolicyRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetPolicyRequestTypeDef
def get_value() -> GetPolicyRequestTypeDef:
return {
"applicationId": ...,
}
# GetPolicyRequestTypeDef definition
class GetPolicyRequestTypeDef(TypedDict):
applicationId: str,GetRetrieverRequestTypeDef#
# GetRetrieverRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetRetrieverRequestTypeDef
def get_value() -> GetRetrieverRequestTypeDef:
return {
"applicationId": ...,
}
# GetRetrieverRequestTypeDef definition
class GetRetrieverRequestTypeDef(TypedDict):
applicationId: str,
retrieverId: str,GetUserRequestTypeDef#
# GetUserRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetUserRequestTypeDef
def get_value() -> GetUserRequestTypeDef:
return {
"applicationId": ...,
}
# GetUserRequestTypeDef definition
class GetUserRequestTypeDef(TypedDict):
applicationId: str,
userId: str,GetWebExperienceRequestTypeDef#
# GetWebExperienceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetWebExperienceRequestTypeDef
def get_value() -> GetWebExperienceRequestTypeDef:
return {
"applicationId": ...,
}
# GetWebExperienceRequestTypeDef definition
class GetWebExperienceRequestTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,MemberGroupTypeDef#
# MemberGroupTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import MemberGroupTypeDef
def get_value() -> MemberGroupTypeDef:
return {
"groupName": ...,
}
# MemberGroupTypeDef definition
class MemberGroupTypeDef(TypedDict):
groupName: str,
type: NotRequired[MembershipTypeType], # (1)MemberUserTypeDef#
# MemberUserTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import MemberUserTypeDef
def get_value() -> MemberUserTypeDef:
return {
"userId": ...,
}
# MemberUserTypeDef definition
class MemberUserTypeDef(TypedDict):
userId: str,
type: NotRequired[MembershipTypeType], # (1)GroupSummaryTypeDef#
# GroupSummaryTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GroupSummaryTypeDef
def get_value() -> GroupSummaryTypeDef:
return {
"groupName": ...,
}
# GroupSummaryTypeDef definition
class GroupSummaryTypeDef(TypedDict):
groupName: NotRequired[str],IdcAuthConfigurationTypeDef#
# IdcAuthConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import IdcAuthConfigurationTypeDef
def get_value() -> IdcAuthConfigurationTypeDef:
return {
"idcApplicationArn": ...,
}
# IdcAuthConfigurationTypeDef definition
class IdcAuthConfigurationTypeDef(TypedDict):
idcApplicationArn: str,
roleArn: str,OpenIDConnectProviderConfigurationTypeDef#
# OpenIDConnectProviderConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import OpenIDConnectProviderConfigurationTypeDef
def get_value() -> OpenIDConnectProviderConfigurationTypeDef:
return {
"secretsArn": ...,
}
# OpenIDConnectProviderConfigurationTypeDef definition
class OpenIDConnectProviderConfigurationTypeDef(TypedDict):
secretsArn: str,
secretsRole: str,SamlProviderConfigurationTypeDef#
# SamlProviderConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SamlProviderConfigurationTypeDef
def get_value() -> SamlProviderConfigurationTypeDef:
return {
"authenticationUrl": ...,
}
# SamlProviderConfigurationTypeDef definition
class SamlProviderConfigurationTypeDef(TypedDict):
authenticationUrl: str,ImageExtractionConfigurationTypeDef#
# ImageExtractionConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ImageExtractionConfigurationTypeDef
def get_value() -> ImageExtractionConfigurationTypeDef:
return {
"imageExtractionStatus": ...,
}
# ImageExtractionConfigurationTypeDef definition
class ImageExtractionConfigurationTypeDef(TypedDict):
imageExtractionStatus: ImageExtractionStatusType, # (1)TextDocumentStatisticsTypeDef#
# TextDocumentStatisticsTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TextDocumentStatisticsTypeDef
def get_value() -> TextDocumentStatisticsTypeDef:
return {
"indexedTextBytes": ...,
}
# TextDocumentStatisticsTypeDef definition
class TextDocumentStatisticsTypeDef(TypedDict):
indexedTextBytes: NotRequired[int],
indexedTextDocumentCount: NotRequired[int],IndexTypeDef#
# IndexTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import IndexTypeDef
def get_value() -> IndexTypeDef:
return {
"displayName": ...,
}
# IndexTypeDef definition
class IndexTypeDef(TypedDict):
displayName: NotRequired[str],
indexId: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
status: NotRequired[IndexStatusType], # (1)- See IndexStatusType
KendraIndexConfigurationTypeDef#
# KendraIndexConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import KendraIndexConfigurationTypeDef
def get_value() -> KendraIndexConfigurationTypeDef:
return {
"indexId": ...,
}
# KendraIndexConfigurationTypeDef definition
class KendraIndexConfigurationTypeDef(TypedDict):
indexId: str,ListApplicationsRequestTypeDef#
# ListApplicationsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListApplicationsRequestTypeDef
def get_value() -> ListApplicationsRequestTypeDef:
return {
"nextToken": ...,
}
# ListApplicationsRequestTypeDef definition
class ListApplicationsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListAttachmentsRequestTypeDef#
# ListAttachmentsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListAttachmentsRequestTypeDef
def get_value() -> ListAttachmentsRequestTypeDef:
return {
"applicationId": ...,
}
# ListAttachmentsRequestTypeDef definition
class ListAttachmentsRequestTypeDef(TypedDict):
applicationId: str,
conversationId: NotRequired[str],
userId: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListConversationsRequestTypeDef#
# ListConversationsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListConversationsRequestTypeDef
def get_value() -> ListConversationsRequestTypeDef:
return {
"applicationId": ...,
}
# ListConversationsRequestTypeDef definition
class ListConversationsRequestTypeDef(TypedDict):
applicationId: str,
userId: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListDataAccessorsRequestTypeDef#
# ListDataAccessorsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataAccessorsRequestTypeDef
def get_value() -> ListDataAccessorsRequestTypeDef:
return {
"applicationId": ...,
}
# ListDataAccessorsRequestTypeDef definition
class ListDataAccessorsRequestTypeDef(TypedDict):
applicationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListDataSourcesRequestTypeDef#
# ListDataSourcesRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataSourcesRequestTypeDef
def get_value() -> ListDataSourcesRequestTypeDef:
return {
"applicationId": ...,
}
# ListDataSourcesRequestTypeDef definition
class ListDataSourcesRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListDocumentsRequestTypeDef#
# ListDocumentsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDocumentsRequestTypeDef
def get_value() -> ListDocumentsRequestTypeDef:
return {
"applicationId": ...,
}
# ListDocumentsRequestTypeDef definition
class ListDocumentsRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceIds: NotRequired[Sequence[str]],
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListIndicesRequestTypeDef#
# ListIndicesRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListIndicesRequestTypeDef
def get_value() -> ListIndicesRequestTypeDef:
return {
"applicationId": ...,
}
# ListIndicesRequestTypeDef definition
class ListIndicesRequestTypeDef(TypedDict):
applicationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListMessagesRequestTypeDef#
# ListMessagesRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListMessagesRequestTypeDef
def get_value() -> ListMessagesRequestTypeDef:
return {
"conversationId": ...,
}
# ListMessagesRequestTypeDef definition
class ListMessagesRequestTypeDef(TypedDict):
conversationId: str,
applicationId: str,
userId: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListPluginActionsRequestTypeDef#
# ListPluginActionsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginActionsRequestTypeDef
def get_value() -> ListPluginActionsRequestTypeDef:
return {
"applicationId": ...,
}
# ListPluginActionsRequestTypeDef definition
class ListPluginActionsRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListPluginTypeActionsRequestTypeDef#
# ListPluginTypeActionsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginTypeActionsRequestTypeDef
def get_value() -> ListPluginTypeActionsRequestTypeDef:
return {
"pluginType": ...,
}
# ListPluginTypeActionsRequestTypeDef definition
class ListPluginTypeActionsRequestTypeDef(TypedDict):
pluginType: PluginTypeType, # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],- See PluginTypeType
ListPluginTypeMetadataRequestTypeDef#
# ListPluginTypeMetadataRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginTypeMetadataRequestTypeDef
def get_value() -> ListPluginTypeMetadataRequestTypeDef:
return {
"nextToken": ...,
}
# ListPluginTypeMetadataRequestTypeDef definition
class ListPluginTypeMetadataRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],PluginTypeMetadataSummaryTypeDef#
# PluginTypeMetadataSummaryTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PluginTypeMetadataSummaryTypeDef
def get_value() -> PluginTypeMetadataSummaryTypeDef:
return {
"type": ...,
}
# PluginTypeMetadataSummaryTypeDef definition
class PluginTypeMetadataSummaryTypeDef(TypedDict):
type: NotRequired[PluginTypeType], # (1)
category: NotRequired[PluginTypeCategoryType], # (2)
description: NotRequired[str],- See PluginTypeType
- See PluginTypeCategoryType
ListPluginsRequestTypeDef#
# ListPluginsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginsRequestTypeDef
def get_value() -> ListPluginsRequestTypeDef:
return {
"applicationId": ...,
}
# ListPluginsRequestTypeDef definition
class ListPluginsRequestTypeDef(TypedDict):
applicationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],PluginTypeDef#
# PluginTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PluginTypeDef
def get_value() -> PluginTypeDef:
return {
"pluginId": ...,
}
# PluginTypeDef definition
class PluginTypeDef(TypedDict):
pluginId: NotRequired[str],
displayName: NotRequired[str],
type: NotRequired[PluginTypeType], # (1)
serverUrl: NotRequired[str],
state: NotRequired[PluginStateType], # (2)
buildStatus: NotRequired[PluginBuildStatusType], # (3)
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],- See PluginTypeType
- See PluginStateType
- See PluginBuildStatusType
ListRetrieversRequestTypeDef#
# ListRetrieversRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListRetrieversRequestTypeDef
def get_value() -> ListRetrieversRequestTypeDef:
return {
"applicationId": ...,
}
# ListRetrieversRequestTypeDef definition
class ListRetrieversRequestTypeDef(TypedDict):
applicationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],RetrieverTypeDef#
# RetrieverTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RetrieverTypeDef
def get_value() -> RetrieverTypeDef:
return {
"applicationId": ...,
}
# RetrieverTypeDef definition
class RetrieverTypeDef(TypedDict):
applicationId: NotRequired[str],
retrieverId: NotRequired[str],
type: NotRequired[RetrieverTypeType], # (1)
status: NotRequired[RetrieverStatusType], # (2)
displayName: NotRequired[str],- See RetrieverTypeType
- See RetrieverStatusType
ListSubscriptionsRequestTypeDef#
# ListSubscriptionsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListSubscriptionsRequestTypeDef
def get_value() -> ListSubscriptionsRequestTypeDef:
return {
"applicationId": ...,
}
# ListSubscriptionsRequestTypeDef definition
class ListSubscriptionsRequestTypeDef(TypedDict):
applicationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],ListTagsForResourceRequestTypeDef#
# ListTagsForResourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListTagsForResourceRequestTypeDef
def get_value() -> ListTagsForResourceRequestTypeDef:
return {
"resourceARN": ...,
}
# ListTagsForResourceRequestTypeDef definition
class ListTagsForResourceRequestTypeDef(TypedDict):
resourceARN: str,ListWebExperiencesRequestTypeDef#
# ListWebExperiencesRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListWebExperiencesRequestTypeDef
def get_value() -> ListWebExperiencesRequestTypeDef:
return {
"applicationId": ...,
}
# ListWebExperiencesRequestTypeDef definition
class ListWebExperiencesRequestTypeDef(TypedDict):
applicationId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],WebExperienceTypeDef#
# WebExperienceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import WebExperienceTypeDef
def get_value() -> WebExperienceTypeDef:
return {
"webExperienceId": ...,
}
# WebExperienceTypeDef definition
class WebExperienceTypeDef(TypedDict):
webExperienceId: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
defaultEndpoint: NotRequired[str],
status: NotRequired[WebExperienceStatusType], # (1)OAuth2ClientCredentialConfigurationTypeDef#
# OAuth2ClientCredentialConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import OAuth2ClientCredentialConfigurationTypeDef
def get_value() -> OAuth2ClientCredentialConfigurationTypeDef:
return {
"secretArn": ...,
}
# OAuth2ClientCredentialConfigurationTypeDef definition
class OAuth2ClientCredentialConfigurationTypeDef(TypedDict):
secretArn: str,
roleArn: str,
authorizationUrl: NotRequired[str],
tokenUrl: NotRequired[str],OrchestrationConfigurationTypeDef#
# OrchestrationConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import OrchestrationConfigurationTypeDef
def get_value() -> OrchestrationConfigurationTypeDef:
return {
"control": ...,
}
# OrchestrationConfigurationTypeDef definition
class OrchestrationConfigurationTypeDef(TypedDict):
control: OrchestrationControlType, # (1)PrincipalGroupTypeDef#
# PrincipalGroupTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PrincipalGroupTypeDef
def get_value() -> PrincipalGroupTypeDef:
return {
"name": ...,
}
# PrincipalGroupTypeDef definition
class PrincipalGroupTypeDef(TypedDict):
access: ReadAccessTypeType, # (1)
name: NotRequired[str],
membershipType: NotRequired[MembershipTypeType], # (2)- See ReadAccessTypeType
- See MembershipTypeType
PrincipalUserTypeDef#
# PrincipalUserTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PrincipalUserTypeDef
def get_value() -> PrincipalUserTypeDef:
return {
"id": ...,
}
# PrincipalUserTypeDef definition
class PrincipalUserTypeDef(TypedDict):
access: ReadAccessTypeType, # (1)
id: NotRequired[str],
membershipType: NotRequired[MembershipTypeType], # (2)- See ReadAccessTypeType
- See MembershipTypeType
ScoreAttributesTypeDef#
# ScoreAttributesTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ScoreAttributesTypeDef
def get_value() -> ScoreAttributesTypeDef:
return {
"scoreConfidence": ...,
}
# ScoreAttributesTypeDef definition
class ScoreAttributesTypeDef(TypedDict):
scoreConfidence: NotRequired[ScoreConfidenceType], # (1)UsersAndGroupsOutputTypeDef#
# UsersAndGroupsOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UsersAndGroupsOutputTypeDef
def get_value() -> UsersAndGroupsOutputTypeDef:
return {
"userIds": ...,
}
# UsersAndGroupsOutputTypeDef definition
class UsersAndGroupsOutputTypeDef(TypedDict):
userIds: NotRequired[List[str]],
userGroups: NotRequired[List[str]],SamlConfigurationTypeDef#
# SamlConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SamlConfigurationTypeDef
def get_value() -> SamlConfigurationTypeDef:
return {
"metadataXML": ...,
}
# SamlConfigurationTypeDef definition
class SamlConfigurationTypeDef(TypedDict):
metadataXML: str,
roleArn: str,
userIdAttribute: str,
userGroupAttribute: NotRequired[str],SnippetExcerptTypeDef#
# SnippetExcerptTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SnippetExcerptTypeDef
def get_value() -> SnippetExcerptTypeDef:
return {
"text": ...,
}
# SnippetExcerptTypeDef definition
class SnippetExcerptTypeDef(TypedDict):
text: NotRequired[str],StartDataSourceSyncJobRequestTypeDef#
# StartDataSourceSyncJobRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import StartDataSourceSyncJobRequestTypeDef
def get_value() -> StartDataSourceSyncJobRequestTypeDef:
return {
"dataSourceId": ...,
}
# StartDataSourceSyncJobRequestTypeDef definition
class StartDataSourceSyncJobRequestTypeDef(TypedDict):
dataSourceId: str,
applicationId: str,
indexId: str,StopDataSourceSyncJobRequestTypeDef#
# StopDataSourceSyncJobRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import StopDataSourceSyncJobRequestTypeDef
def get_value() -> StopDataSourceSyncJobRequestTypeDef:
return {
"dataSourceId": ...,
}
# StopDataSourceSyncJobRequestTypeDef definition
class StopDataSourceSyncJobRequestTypeDef(TypedDict):
dataSourceId: str,
applicationId: str,
indexId: str,UntagResourceRequestTypeDef#
# UntagResourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UntagResourceRequestTypeDef
def get_value() -> UntagResourceRequestTypeDef:
return {
"resourceARN": ...,
}
# UntagResourceRequestTypeDef definition
class UntagResourceRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],UpdateSubscriptionRequestTypeDef#
# UpdateSubscriptionRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateSubscriptionRequestTypeDef
def get_value() -> UpdateSubscriptionRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateSubscriptionRequestTypeDef definition
class UpdateSubscriptionRequestTypeDef(TypedDict):
applicationId: str,
subscriptionId: str,
type: SubscriptionTypeType, # (1)UsersAndGroupsTypeDef#
# UsersAndGroupsTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UsersAndGroupsTypeDef
def get_value() -> UsersAndGroupsTypeDef:
return {
"userIds": ...,
}
# UsersAndGroupsTypeDef definition
class UsersAndGroupsTypeDef(TypedDict):
userIds: NotRequired[Sequence[str]],
userGroups: NotRequired[Sequence[str]],APISchemaTypeDef#
# APISchemaTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import APISchemaTypeDef
def get_value() -> APISchemaTypeDef:
return {
"payload": ...,
}
# APISchemaTypeDef definition
class APISchemaTypeDef(TypedDict):
payload: NotRequired[str],
s3: NotRequired[S3TypeDef], # (1)- See S3TypeDef
ActionExecutionOutputTypeDef#
# ActionExecutionOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionExecutionOutputTypeDef
def get_value() -> ActionExecutionOutputTypeDef:
return {
"pluginId": ...,
}
# ActionExecutionOutputTypeDef definition
class ActionExecutionOutputTypeDef(TypedDict):
pluginId: str,
payload: Dict[str, ActionExecutionPayloadFieldOutputTypeDef], # (1)
payloadFieldNameSeparator: str,ActionExecutionTypeDef#
# ActionExecutionTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionExecutionTypeDef
def get_value() -> ActionExecutionTypeDef:
return {
"pluginId": ...,
}
# ActionExecutionTypeDef definition
class ActionExecutionTypeDef(TypedDict):
pluginId: str,
payload: Mapping[str, ActionExecutionPayloadFieldTypeDef], # (1)
payloadFieldNameSeparator: str,ActionReviewPayloadFieldTypeDef#
# ActionReviewPayloadFieldTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionReviewPayloadFieldTypeDef
def get_value() -> ActionReviewPayloadFieldTypeDef:
return {
"displayName": ...,
}
# ActionReviewPayloadFieldTypeDef definition
class ActionReviewPayloadFieldTypeDef(TypedDict):
displayName: NotRequired[str],
displayOrder: NotRequired[int],
displayDescription: NotRequired[str],
type: NotRequired[ActionPayloadFieldTypeType], # (1)
value: NotRequired[Dict[str, Any]],
allowedValues: NotRequired[List[ActionReviewPayloadFieldAllowedValueTypeDef]], # (2)
allowedFormat: NotRequired[str],
arrayItemJsonSchema: NotRequired[Dict[str, Any]],
required: NotRequired[bool],ApplicationTypeDef#
# ApplicationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ApplicationTypeDef
def get_value() -> ApplicationTypeDef:
return {
"displayName": ...,
}
# ApplicationTypeDef definition
class ApplicationTypeDef(TypedDict):
displayName: NotRequired[str],
applicationId: NotRequired[str],
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],
status: NotRequired[ApplicationStatusType], # (1)
identityType: NotRequired[IdentityTypeType], # (2)
quickSightConfiguration: NotRequired[QuickSightConfigurationTypeDef], # (3)AssociatePermissionResponseTypeDef#
# AssociatePermissionResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AssociatePermissionResponseTypeDef
def get_value() -> AssociatePermissionResponseTypeDef:
return {
"statement": ...,
}
# AssociatePermissionResponseTypeDef definition
class AssociatePermissionResponseTypeDef(TypedDict):
statement: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateApplicationResponseTypeDef#
# CreateApplicationResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateApplicationResponseTypeDef
def get_value() -> CreateApplicationResponseTypeDef:
return {
"applicationId": ...,
}
# CreateApplicationResponseTypeDef definition
class CreateApplicationResponseTypeDef(TypedDict):
applicationId: str,
applicationArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDataAccessorResponseTypeDef#
# CreateDataAccessorResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateDataAccessorResponseTypeDef
def get_value() -> CreateDataAccessorResponseTypeDef:
return {
"dataAccessorId": ...,
}
# CreateDataAccessorResponseTypeDef definition
class CreateDataAccessorResponseTypeDef(TypedDict):
dataAccessorId: str,
idcApplicationArn: str,
dataAccessorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateDataSourceResponseTypeDef#
# CreateDataSourceResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateDataSourceResponseTypeDef
def get_value() -> CreateDataSourceResponseTypeDef:
return {
"dataSourceId": ...,
}
# CreateDataSourceResponseTypeDef definition
class CreateDataSourceResponseTypeDef(TypedDict):
dataSourceId: str,
dataSourceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateIndexResponseTypeDef#
# CreateIndexResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateIndexResponseTypeDef
def get_value() -> CreateIndexResponseTypeDef:
return {
"indexId": ...,
}
# CreateIndexResponseTypeDef definition
class CreateIndexResponseTypeDef(TypedDict):
indexId: str,
indexArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreatePluginResponseTypeDef#
# CreatePluginResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreatePluginResponseTypeDef
def get_value() -> CreatePluginResponseTypeDef:
return {
"pluginId": ...,
}
# CreatePluginResponseTypeDef definition
class CreatePluginResponseTypeDef(TypedDict):
pluginId: str,
pluginArn: str,
buildStatus: PluginBuildStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)CreateRetrieverResponseTypeDef#
# CreateRetrieverResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateRetrieverResponseTypeDef
def get_value() -> CreateRetrieverResponseTypeDef:
return {
"retrieverId": ...,
}
# CreateRetrieverResponseTypeDef definition
class CreateRetrieverResponseTypeDef(TypedDict):
retrieverId: str,
retrieverArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)CreateWebExperienceResponseTypeDef#
# CreateWebExperienceResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateWebExperienceResponseTypeDef
def get_value() -> CreateWebExperienceResponseTypeDef:
return {
"webExperienceId": ...,
}
# CreateWebExperienceResponseTypeDef definition
class CreateWebExperienceResponseTypeDef(TypedDict):
webExperienceId: str,
webExperienceArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetMediaResponseTypeDef#
# GetMediaResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetMediaResponseTypeDef
def get_value() -> GetMediaResponseTypeDef:
return {
"mediaBytes": ...,
}
# GetMediaResponseTypeDef definition
class GetMediaResponseTypeDef(TypedDict):
mediaBytes: bytes,
mediaMimeType: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)GetPolicyResponseTypeDef#
# GetPolicyResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetPolicyResponseTypeDef
def get_value() -> GetPolicyResponseTypeDef:
return {
"policy": ...,
}
# GetPolicyResponseTypeDef definition
class GetPolicyResponseTypeDef(TypedDict):
policy: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)ListPluginActionsResponseTypeDef#
# ListPluginActionsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginActionsResponseTypeDef
def get_value() -> ListPluginActionsResponseTypeDef:
return {
"nextToken": ...,
}
# ListPluginActionsResponseTypeDef definition
class ListPluginActionsResponseTypeDef(TypedDict):
items: List[ActionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListPluginTypeActionsResponseTypeDef#
# ListPluginTypeActionsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginTypeActionsResponseTypeDef
def get_value() -> ListPluginTypeActionsResponseTypeDef:
return {
"nextToken": ...,
}
# ListPluginTypeActionsResponseTypeDef definition
class ListPluginTypeActionsResponseTypeDef(TypedDict):
items: List[ActionSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],StartDataSourceSyncJobResponseTypeDef#
# StartDataSourceSyncJobResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import StartDataSourceSyncJobResponseTypeDef
def get_value() -> StartDataSourceSyncJobResponseTypeDef:
return {
"executionId": ...,
}
# StartDataSourceSyncJobResponseTypeDef definition
class StartDataSourceSyncJobResponseTypeDef(TypedDict):
executionId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)DocumentContentTypeDef#
# DocumentContentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentContentTypeDef
def get_value() -> DocumentContentTypeDef:
return {
"blob": ...,
}
# DocumentContentTypeDef definition
class DocumentContentTypeDef(TypedDict):
blob: NotRequired[BlobTypeDef],
s3: NotRequired[S3TypeDef], # (1)- See S3TypeDef
AttachmentOutputTypeDef#
# AttachmentOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttachmentOutputTypeDef
def get_value() -> AttachmentOutputTypeDef:
return {
"name": ...,
}
# AttachmentOutputTypeDef definition
class AttachmentOutputTypeDef(TypedDict):
name: NotRequired[str],
status: NotRequired[AttachmentStatusType], # (1)
error: NotRequired[ErrorDetailTypeDef], # (2)
attachmentId: NotRequired[str],
conversationId: NotRequired[str],DocumentDetailsTypeDef#
# DocumentDetailsTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentDetailsTypeDef
def get_value() -> DocumentDetailsTypeDef:
return {
"documentId": ...,
}
# DocumentDetailsTypeDef definition
class DocumentDetailsTypeDef(TypedDict):
documentId: NotRequired[str],
status: NotRequired[DocumentStatusType], # (1)
error: NotRequired[ErrorDetailTypeDef], # (2)
createdAt: NotRequired[datetime],
updatedAt: NotRequired[datetime],- See DocumentStatusType
- See ErrorDetailTypeDef
FailedDocumentTypeDef#
# FailedDocumentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import FailedDocumentTypeDef
def get_value() -> FailedDocumentTypeDef:
return {
"id": ...,
}
# FailedDocumentTypeDef definition
class FailedDocumentTypeDef(TypedDict):
id: NotRequired[str],
error: NotRequired[ErrorDetailTypeDef], # (1)
dataSourceId: NotRequired[str],GroupStatusDetailTypeDef#
# GroupStatusDetailTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GroupStatusDetailTypeDef
def get_value() -> GroupStatusDetailTypeDef:
return {
"status": ...,
}
# GroupStatusDetailTypeDef definition
class GroupStatusDetailTypeDef(TypedDict):
status: NotRequired[GroupStatusType], # (1)
lastUpdatedAt: NotRequired[datetime],
errorDetail: NotRequired[ErrorDetailTypeDef], # (2)- See GroupStatusType
- See ErrorDetailTypeDef
BatchDeleteDocumentRequestTypeDef#
# BatchDeleteDocumentRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BatchDeleteDocumentRequestTypeDef
def get_value() -> BatchDeleteDocumentRequestTypeDef:
return {
"applicationId": ...,
}
# BatchDeleteDocumentRequestTypeDef definition
class BatchDeleteDocumentRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
documents: Sequence[DeleteDocumentTypeDef], # (1)
dataSourceSyncId: NotRequired[str],CancelSubscriptionResponseTypeDef#
# CancelSubscriptionResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CancelSubscriptionResponseTypeDef
def get_value() -> CancelSubscriptionResponseTypeDef:
return {
"subscriptionArn": ...,
}
# CancelSubscriptionResponseTypeDef definition
class CancelSubscriptionResponseTypeDef(TypedDict):
subscriptionArn: str,
currentSubscription: SubscriptionDetailsTypeDef, # (1)
nextSubscription: SubscriptionDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)CreateSubscriptionResponseTypeDef#
# CreateSubscriptionResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateSubscriptionResponseTypeDef
def get_value() -> CreateSubscriptionResponseTypeDef:
return {
"subscriptionId": ...,
}
# CreateSubscriptionResponseTypeDef definition
class CreateSubscriptionResponseTypeDef(TypedDict):
subscriptionId: str,
subscriptionArn: str,
currentSubscription: SubscriptionDetailsTypeDef, # (1)
nextSubscription: SubscriptionDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)UpdateSubscriptionResponseTypeDef#
# UpdateSubscriptionResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateSubscriptionResponseTypeDef
def get_value() -> UpdateSubscriptionResponseTypeDef:
return {
"subscriptionArn": ...,
}
# UpdateSubscriptionResponseTypeDef definition
class UpdateSubscriptionResponseTypeDef(TypedDict):
subscriptionArn: str,
currentSubscription: SubscriptionDetailsTypeDef, # (1)
nextSubscription: SubscriptionDetailsTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (3)ChatModeConfigurationTypeDef#
# ChatModeConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatModeConfigurationTypeDef
def get_value() -> ChatModeConfigurationTypeDef:
return {
"pluginConfiguration": ...,
}
# ChatModeConfigurationTypeDef definition
class ChatModeConfigurationTypeDef(TypedDict):
pluginConfiguration: NotRequired[PluginConfigurationTypeDef], # (1)ContentRetrievalRuleOutputTypeDef#
# ContentRetrievalRuleOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ContentRetrievalRuleOutputTypeDef
def get_value() -> ContentRetrievalRuleOutputTypeDef:
return {
"eligibleDataSources": ...,
}
# ContentRetrievalRuleOutputTypeDef definition
class ContentRetrievalRuleOutputTypeDef(TypedDict):
eligibleDataSources: NotRequired[List[EligibleDataSourceTypeDef]], # (1)ContentRetrievalRuleTypeDef#
# ContentRetrievalRuleTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ContentRetrievalRuleTypeDef
def get_value() -> ContentRetrievalRuleTypeDef:
return {
"eligibleDataSources": ...,
}
# ContentRetrievalRuleTypeDef definition
class ContentRetrievalRuleTypeDef(TypedDict):
eligibleDataSources: NotRequired[Sequence[EligibleDataSourceTypeDef]], # (1)ContentSourceTypeDef#
# ContentSourceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ContentSourceTypeDef
def get_value() -> ContentSourceTypeDef:
return {
"retriever": ...,
}
# ContentSourceTypeDef definition
class ContentSourceTypeDef(TypedDict):
retriever: NotRequired[RetrieverContentSourceTypeDef], # (1)CopyFromSourceTypeDef#
# CopyFromSourceTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CopyFromSourceTypeDef
def get_value() -> CopyFromSourceTypeDef:
return {
"conversation": ...,
}
# CopyFromSourceTypeDef definition
class CopyFromSourceTypeDef(TypedDict):
conversation: NotRequired[ConversationSourceTypeDef], # (1)ListConversationsResponseTypeDef#
# ListConversationsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListConversationsResponseTypeDef
def get_value() -> ListConversationsResponseTypeDef:
return {
"nextToken": ...,
}
# ListConversationsResponseTypeDef definition
class ListConversationsResponseTypeDef(TypedDict):
conversations: List[ConversationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],GetApplicationResponseTypeDef#
# GetApplicationResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetApplicationResponseTypeDef
def get_value() -> GetApplicationResponseTypeDef:
return {
"displayName": ...,
}
# GetApplicationResponseTypeDef definition
class GetApplicationResponseTypeDef(TypedDict):
displayName: str,
applicationId: str,
applicationArn: str,
identityType: IdentityTypeType, # (1)
iamIdentityProviderArn: str,
identityCenterApplicationArn: str,
roleArn: str,
status: ApplicationStatusType, # (2)
description: str,
encryptionConfiguration: EncryptionConfigurationTypeDef, # (3)
createdAt: datetime,
updatedAt: datetime,
error: ErrorDetailTypeDef, # (4)
attachmentsConfiguration: AppliedAttachmentsConfigurationTypeDef, # (5)
qAppsConfiguration: QAppsConfigurationTypeDef, # (6)
personalizationConfiguration: PersonalizationConfigurationTypeDef, # (7)
autoSubscriptionConfiguration: AutoSubscriptionConfigurationTypeDef, # (8)
clientIdsForOIDC: List[str],
quickSightConfiguration: QuickSightConfigurationTypeDef, # (9)
ResponseMetadata: ResponseMetadataTypeDef, # (10)- See IdentityTypeType
- See ApplicationStatusType
- See EncryptionConfigurationTypeDef
- See ErrorDetailTypeDef
- See AppliedAttachmentsConfigurationTypeDef
- See QAppsConfigurationTypeDef
- See PersonalizationConfigurationTypeDef
- See AutoSubscriptionConfigurationTypeDef
- See QuickSightConfigurationTypeDef
- See ResponseMetadataTypeDef
UpdateApplicationRequestTypeDef#
# UpdateApplicationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateApplicationRequestTypeDef
def get_value() -> UpdateApplicationRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateApplicationRequestTypeDef definition
class UpdateApplicationRequestTypeDef(TypedDict):
applicationId: str,
identityCenterInstanceArn: NotRequired[str],
displayName: NotRequired[str],
description: NotRequired[str],
roleArn: NotRequired[str],
attachmentsConfiguration: NotRequired[AttachmentsConfigurationTypeDef], # (1)
qAppsConfiguration: NotRequired[QAppsConfigurationTypeDef], # (2)
personalizationConfiguration: NotRequired[PersonalizationConfigurationTypeDef], # (3)
autoSubscriptionConfiguration: NotRequired[AutoSubscriptionConfigurationTypeDef], # (4)- See AttachmentsConfigurationTypeDef
- See QAppsConfigurationTypeDef
- See PersonalizationConfigurationTypeDef
- See AutoSubscriptionConfigurationTypeDef
CreateApplicationRequestTypeDef#
# CreateApplicationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateApplicationRequestTypeDef
def get_value() -> CreateApplicationRequestTypeDef:
return {
"displayName": ...,
}
# CreateApplicationRequestTypeDef definition
class CreateApplicationRequestTypeDef(TypedDict):
displayName: str,
roleArn: NotRequired[str],
identityType: NotRequired[IdentityTypeType], # (1)
iamIdentityProviderArn: NotRequired[str],
identityCenterInstanceArn: NotRequired[str],
clientIdsForOIDC: NotRequired[Sequence[str]],
description: NotRequired[str],
encryptionConfiguration: NotRequired[EncryptionConfigurationTypeDef], # (2)
tags: NotRequired[Sequence[TagTypeDef]], # (3)
clientToken: NotRequired[str],
attachmentsConfiguration: NotRequired[AttachmentsConfigurationTypeDef], # (4)
qAppsConfiguration: NotRequired[QAppsConfigurationTypeDef], # (5)
personalizationConfiguration: NotRequired[PersonalizationConfigurationTypeDef], # (6)
quickSightConfiguration: NotRequired[QuickSightConfigurationTypeDef], # (7)- See IdentityTypeType
- See EncryptionConfigurationTypeDef
- See TagTypeDef
- See AttachmentsConfigurationTypeDef
- See QAppsConfigurationTypeDef
- See PersonalizationConfigurationTypeDef
- See QuickSightConfigurationTypeDef
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)- See TagTypeDef
- See ResponseMetadataTypeDef
TagResourceRequestTypeDef#
# TagResourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TagResourceRequestTypeDef
def get_value() -> TagResourceRequestTypeDef:
return {
"resourceARN": ...,
}
# TagResourceRequestTypeDef definition
class TagResourceRequestTypeDef(TypedDict):
resourceARN: str,
tags: Sequence[TagTypeDef], # (1)- See TagTypeDef
CreateIndexRequestTypeDef#
# CreateIndexRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateIndexRequestTypeDef
def get_value() -> CreateIndexRequestTypeDef:
return {
"applicationId": ...,
}
# CreateIndexRequestTypeDef definition
class CreateIndexRequestTypeDef(TypedDict):
applicationId: str,
displayName: str,
description: NotRequired[str],
type: NotRequired[IndexTypeType], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef], # (3)
clientToken: NotRequired[str],- See IndexTypeType
- See TagTypeDef
- See IndexCapacityConfigurationTypeDef
CreateSubscriptionRequestTypeDef#
# CreateSubscriptionRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateSubscriptionRequestTypeDef
def get_value() -> CreateSubscriptionRequestTypeDef:
return {
"applicationId": ...,
}
# CreateSubscriptionRequestTypeDef definition
class CreateSubscriptionRequestTypeDef(TypedDict):
applicationId: str,
principal: SubscriptionPrincipalTypeDef, # (1)
type: SubscriptionTypeType, # (2)
clientToken: NotRequired[str],SubscriptionTypeDef#
# SubscriptionTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SubscriptionTypeDef
def get_value() -> SubscriptionTypeDef:
return {
"subscriptionId": ...,
}
# SubscriptionTypeDef definition
class SubscriptionTypeDef(TypedDict):
subscriptionId: NotRequired[str],
subscriptionArn: NotRequired[str],
principal: NotRequired[SubscriptionPrincipalTypeDef], # (1)
currentSubscription: NotRequired[SubscriptionDetailsTypeDef], # (2)
nextSubscription: NotRequired[SubscriptionDetailsTypeDef], # (2)CreateUserRequestTypeDef#
# CreateUserRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateUserRequestTypeDef
def get_value() -> CreateUserRequestTypeDef:
return {
"applicationId": ...,
}
# CreateUserRequestTypeDef definition
class CreateUserRequestTypeDef(TypedDict):
applicationId: str,
userId: str,
userAliases: NotRequired[Sequence[UserAliasTypeDef]], # (1)
clientToken: NotRequired[str],- See UserAliasTypeDef
GetUserResponseTypeDef#
# GetUserResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetUserResponseTypeDef
def get_value() -> GetUserResponseTypeDef:
return {
"userAliases": ...,
}
# GetUserResponseTypeDef definition
class GetUserResponseTypeDef(TypedDict):
userAliases: List[UserAliasTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)UpdateUserRequestTypeDef#
# UpdateUserRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateUserRequestTypeDef
def get_value() -> UpdateUserRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateUserRequestTypeDef definition
class UpdateUserRequestTypeDef(TypedDict):
applicationId: str,
userId: str,
userAliasesToUpdate: NotRequired[Sequence[UserAliasTypeDef]], # (1)
userAliasesToDelete: NotRequired[Sequence[UserAliasTypeDef]], # (1)- See UserAliasTypeDef
- See UserAliasTypeDef
UpdateUserResponseTypeDef#
# UpdateUserResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateUserResponseTypeDef
def get_value() -> UpdateUserResponseTypeDef:
return {
"userAliasesAdded": ...,
}
# UpdateUserResponseTypeDef definition
class UpdateUserResponseTypeDef(TypedDict):
userAliasesAdded: List[UserAliasTypeDef], # (1)
userAliasesUpdated: List[UserAliasTypeDef], # (1)
userAliasesDeleted: List[UserAliasTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See UserAliasTypeDef
- See UserAliasTypeDef
- See UserAliasTypeDef
- See ResponseMetadataTypeDef
ListDataAccessorsResponseTypeDef#
# ListDataAccessorsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataAccessorsResponseTypeDef
def get_value() -> ListDataAccessorsResponseTypeDef:
return {
"dataAccessors": ...,
}
# ListDataAccessorsResponseTypeDef definition
class ListDataAccessorsResponseTypeDef(TypedDict):
dataAccessors: List[DataAccessorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],DataSourceSyncJobTypeDef#
# DataSourceSyncJobTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DataSourceSyncJobTypeDef
def get_value() -> DataSourceSyncJobTypeDef:
return {
"executionId": ...,
}
# DataSourceSyncJobTypeDef definition
class DataSourceSyncJobTypeDef(TypedDict):
executionId: NotRequired[str],
startTime: NotRequired[datetime],
endTime: NotRequired[datetime],
status: NotRequired[DataSourceSyncJobStatusType], # (1)
error: NotRequired[ErrorDetailTypeDef], # (2)
dataSourceErrorCode: NotRequired[str],
metrics: NotRequired[DataSourceSyncJobMetricsTypeDef], # (3)ListDataSourcesResponseTypeDef#
# ListDataSourcesResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataSourcesResponseTypeDef
def get_value() -> ListDataSourcesResponseTypeDef:
return {
"dataSources": ...,
}
# ListDataSourcesResponseTypeDef definition
class ListDataSourcesResponseTypeDef(TypedDict):
dataSources: List[DataSourceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],DocumentAttributeBoostingConfigurationOutputTypeDef#
# DocumentAttributeBoostingConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeBoostingConfigurationOutputTypeDef
def get_value() -> DocumentAttributeBoostingConfigurationOutputTypeDef:
return {
"numberConfiguration": ...,
}
# DocumentAttributeBoostingConfigurationOutputTypeDef definition
class DocumentAttributeBoostingConfigurationOutputTypeDef(TypedDict):
numberConfiguration: NotRequired[NumberAttributeBoostingConfigurationTypeDef], # (1)
stringConfiguration: NotRequired[StringAttributeBoostingConfigurationOutputTypeDef], # (2)
dateConfiguration: NotRequired[DateAttributeBoostingConfigurationTypeDef], # (3)
stringListConfiguration: NotRequired[StringListAttributeBoostingConfigurationTypeDef], # (4)- See NumberAttributeBoostingConfigurationTypeDef
- See StringAttributeBoostingConfigurationOutputTypeDef
- See DateAttributeBoostingConfigurationTypeDef
- See StringListAttributeBoostingConfigurationTypeDef
DocumentAttributeBoostingConfigurationTypeDef#
# DocumentAttributeBoostingConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeBoostingConfigurationTypeDef
def get_value() -> DocumentAttributeBoostingConfigurationTypeDef:
return {
"numberConfiguration": ...,
}
# DocumentAttributeBoostingConfigurationTypeDef definition
class DocumentAttributeBoostingConfigurationTypeDef(TypedDict):
numberConfiguration: NotRequired[NumberAttributeBoostingConfigurationTypeDef], # (1)
stringConfiguration: NotRequired[StringAttributeBoostingConfigurationTypeDef], # (2)
dateConfiguration: NotRequired[DateAttributeBoostingConfigurationTypeDef], # (3)
stringListConfiguration: NotRequired[StringListAttributeBoostingConfigurationTypeDef], # (4)- See NumberAttributeBoostingConfigurationTypeDef
- See StringAttributeBoostingConfigurationTypeDef
- See DateAttributeBoostingConfigurationTypeDef
- See StringListAttributeBoostingConfigurationTypeDef
DocumentAttributeConditionOutputTypeDef#
# DocumentAttributeConditionOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeConditionOutputTypeDef
def get_value() -> DocumentAttributeConditionOutputTypeDef:
return {
"key": ...,
}
# DocumentAttributeConditionOutputTypeDef definition
class DocumentAttributeConditionOutputTypeDef(TypedDict):
key: str,
operator: DocumentEnrichmentConditionOperatorType, # (1)
value: NotRequired[DocumentAttributeValueOutputTypeDef], # (2)DocumentAttributeOutputTypeDef#
# DocumentAttributeOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeOutputTypeDef
def get_value() -> DocumentAttributeOutputTypeDef:
return {
"name": ...,
}
# DocumentAttributeOutputTypeDef definition
class DocumentAttributeOutputTypeDef(TypedDict):
name: str,
value: DocumentAttributeValueOutputTypeDef, # (1)DocumentAttributeTargetOutputTypeDef#
# DocumentAttributeTargetOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeTargetOutputTypeDef
def get_value() -> DocumentAttributeTargetOutputTypeDef:
return {
"key": ...,
}
# DocumentAttributeTargetOutputTypeDef definition
class DocumentAttributeTargetOutputTypeDef(TypedDict):
key: str,
value: NotRequired[DocumentAttributeValueOutputTypeDef], # (1)
attributeValueOperator: NotRequired[AttributeValueOperatorType], # (2)UpdateIndexRequestTypeDef#
# UpdateIndexRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateIndexRequestTypeDef
def get_value() -> UpdateIndexRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateIndexRequestTypeDef definition
class UpdateIndexRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
displayName: NotRequired[str],
description: NotRequired[str],
capacityConfiguration: NotRequired[IndexCapacityConfigurationTypeDef], # (1)
documentAttributeConfigurations: NotRequired[Sequence[DocumentAttributeConfigurationTypeDef]], # (2)DocumentAttributeValueTypeDef#
# DocumentAttributeValueTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeValueTypeDef
def get_value() -> DocumentAttributeValueTypeDef:
return {
"stringValue": ...,
}
# DocumentAttributeValueTypeDef definition
class DocumentAttributeValueTypeDef(TypedDict):
stringValue: NotRequired[str],
stringListValue: NotRequired[Sequence[str]],
longValue: NotRequired[int],
dateValue: NotRequired[TimestampTypeDef],ListDataSourceSyncJobsRequestTypeDef#
# ListDataSourceSyncJobsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataSourceSyncJobsRequestTypeDef
def get_value() -> ListDataSourceSyncJobsRequestTypeDef:
return {
"dataSourceId": ...,
}
# ListDataSourceSyncJobsRequestTypeDef definition
class ListDataSourceSyncJobsRequestTypeDef(TypedDict):
dataSourceId: str,
applicationId: str,
indexId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
statusFilter: NotRequired[DataSourceSyncJobStatusType], # (1)ListGroupsRequestTypeDef#
# ListGroupsRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListGroupsRequestTypeDef
def get_value() -> ListGroupsRequestTypeDef:
return {
"applicationId": ...,
}
# ListGroupsRequestTypeDef definition
class ListGroupsRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
updatedEarlierThan: TimestampTypeDef,
dataSourceId: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],MessageUsefulnessFeedbackTypeDef#
# MessageUsefulnessFeedbackTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import MessageUsefulnessFeedbackTypeDef
def get_value() -> MessageUsefulnessFeedbackTypeDef:
return {
"usefulness": ...,
}
# MessageUsefulnessFeedbackTypeDef definition
class MessageUsefulnessFeedbackTypeDef(TypedDict):
usefulness: MessageUsefulnessType, # (1)
submittedAt: TimestampTypeDef,
reason: NotRequired[MessageUsefulnessReasonType], # (2)
comment: NotRequired[str],GetChatControlsConfigurationRequestPaginateTypeDef#
# GetChatControlsConfigurationRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetChatControlsConfigurationRequestPaginateTypeDef
def get_value() -> GetChatControlsConfigurationRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# GetChatControlsConfigurationRequestPaginateTypeDef definition
class GetChatControlsConfigurationRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListApplicationsRequestPaginateTypeDef#
# ListApplicationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListApplicationsRequestPaginateTypeDef
def get_value() -> ListApplicationsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListApplicationsRequestPaginateTypeDef definition
class ListApplicationsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListAttachmentsRequestPaginateTypeDef#
# ListAttachmentsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListAttachmentsRequestPaginateTypeDef
def get_value() -> ListAttachmentsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListAttachmentsRequestPaginateTypeDef definition
class ListAttachmentsRequestPaginateTypeDef(TypedDict):
applicationId: str,
conversationId: NotRequired[str],
userId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListConversationsRequestPaginateTypeDef#
# ListConversationsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListConversationsRequestPaginateTypeDef
def get_value() -> ListConversationsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListConversationsRequestPaginateTypeDef definition
class ListConversationsRequestPaginateTypeDef(TypedDict):
applicationId: str,
userId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDataAccessorsRequestPaginateTypeDef#
# ListDataAccessorsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataAccessorsRequestPaginateTypeDef
def get_value() -> ListDataAccessorsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListDataAccessorsRequestPaginateTypeDef definition
class ListDataAccessorsRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDataSourceSyncJobsRequestPaginateTypeDef#
# ListDataSourceSyncJobsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataSourceSyncJobsRequestPaginateTypeDef
def get_value() -> ListDataSourceSyncJobsRequestPaginateTypeDef:
return {
"dataSourceId": ...,
}
# ListDataSourceSyncJobsRequestPaginateTypeDef definition
class ListDataSourceSyncJobsRequestPaginateTypeDef(TypedDict):
dataSourceId: str,
applicationId: str,
indexId: str,
startTime: NotRequired[TimestampTypeDef],
endTime: NotRequired[TimestampTypeDef],
statusFilter: NotRequired[DataSourceSyncJobStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)ListDataSourcesRequestPaginateTypeDef#
# ListDataSourcesRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataSourcesRequestPaginateTypeDef
def get_value() -> ListDataSourcesRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListDataSourcesRequestPaginateTypeDef definition
class ListDataSourcesRequestPaginateTypeDef(TypedDict):
applicationId: str,
indexId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListDocumentsRequestPaginateTypeDef#
# ListDocumentsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDocumentsRequestPaginateTypeDef
def get_value() -> ListDocumentsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListDocumentsRequestPaginateTypeDef definition
class ListDocumentsRequestPaginateTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceIds: NotRequired[Sequence[str]],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListGroupsRequestPaginateTypeDef#
# ListGroupsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListGroupsRequestPaginateTypeDef
def get_value() -> ListGroupsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListGroupsRequestPaginateTypeDef definition
class ListGroupsRequestPaginateTypeDef(TypedDict):
applicationId: str,
indexId: str,
updatedEarlierThan: TimestampTypeDef,
dataSourceId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListIndicesRequestPaginateTypeDef#
# ListIndicesRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListIndicesRequestPaginateTypeDef
def get_value() -> ListIndicesRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListIndicesRequestPaginateTypeDef definition
class ListIndicesRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListMessagesRequestPaginateTypeDef#
# ListMessagesRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListMessagesRequestPaginateTypeDef
def get_value() -> ListMessagesRequestPaginateTypeDef:
return {
"conversationId": ...,
}
# ListMessagesRequestPaginateTypeDef definition
class ListMessagesRequestPaginateTypeDef(TypedDict):
conversationId: str,
applicationId: str,
userId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPluginActionsRequestPaginateTypeDef#
# ListPluginActionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginActionsRequestPaginateTypeDef
def get_value() -> ListPluginActionsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListPluginActionsRequestPaginateTypeDef definition
class ListPluginActionsRequestPaginateTypeDef(TypedDict):
applicationId: str,
pluginId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPluginTypeActionsRequestPaginateTypeDef#
# ListPluginTypeActionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginTypeActionsRequestPaginateTypeDef
def get_value() -> ListPluginTypeActionsRequestPaginateTypeDef:
return {
"pluginType": ...,
}
# ListPluginTypeActionsRequestPaginateTypeDef definition
class ListPluginTypeActionsRequestPaginateTypeDef(TypedDict):
pluginType: PluginTypeType, # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)- See PluginTypeType
- See PaginatorConfigTypeDef
ListPluginTypeMetadataRequestPaginateTypeDef#
# ListPluginTypeMetadataRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginTypeMetadataRequestPaginateTypeDef
def get_value() -> ListPluginTypeMetadataRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListPluginTypeMetadataRequestPaginateTypeDef definition
class ListPluginTypeMetadataRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListPluginsRequestPaginateTypeDef#
# ListPluginsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginsRequestPaginateTypeDef
def get_value() -> ListPluginsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListPluginsRequestPaginateTypeDef definition
class ListPluginsRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListRetrieversRequestPaginateTypeDef#
# ListRetrieversRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListRetrieversRequestPaginateTypeDef
def get_value() -> ListRetrieversRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListRetrieversRequestPaginateTypeDef definition
class ListRetrieversRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListSubscriptionsRequestPaginateTypeDef#
# ListSubscriptionsRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListSubscriptionsRequestPaginateTypeDef
def get_value() -> ListSubscriptionsRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListSubscriptionsRequestPaginateTypeDef definition
class ListSubscriptionsRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)ListWebExperiencesRequestPaginateTypeDef#
# ListWebExperiencesRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListWebExperiencesRequestPaginateTypeDef
def get_value() -> ListWebExperiencesRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# ListWebExperiencesRequestPaginateTypeDef definition
class ListWebExperiencesRequestPaginateTypeDef(TypedDict):
applicationId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)GroupMembersTypeDef#
# GroupMembersTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GroupMembersTypeDef
def get_value() -> GroupMembersTypeDef:
return {
"memberGroups": ...,
}
# GroupMembersTypeDef definition
class GroupMembersTypeDef(TypedDict):
memberGroups: NotRequired[Sequence[MemberGroupTypeDef]], # (1)
memberUsers: NotRequired[Sequence[MemberUserTypeDef]], # (2)
s3PathForGroupMembers: NotRequired[S3TypeDef], # (3)- See MemberGroupTypeDef
- See MemberUserTypeDef
- See S3TypeDef
ListGroupsResponseTypeDef#
# ListGroupsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListGroupsResponseTypeDef
def get_value() -> ListGroupsResponseTypeDef:
return {
"nextToken": ...,
}
# ListGroupsResponseTypeDef definition
class ListGroupsResponseTypeDef(TypedDict):
items: List[GroupSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],IdentityProviderConfigurationTypeDef#
# IdentityProviderConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import IdentityProviderConfigurationTypeDef
def get_value() -> IdentityProviderConfigurationTypeDef:
return {
"samlConfiguration": ...,
}
# IdentityProviderConfigurationTypeDef definition
class IdentityProviderConfigurationTypeDef(TypedDict):
samlConfiguration: NotRequired[SamlProviderConfigurationTypeDef], # (1)
openIDConnectConfiguration: NotRequired[OpenIDConnectProviderConfigurationTypeDef], # (2)MediaExtractionConfigurationTypeDef#
# MediaExtractionConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import MediaExtractionConfigurationTypeDef
def get_value() -> MediaExtractionConfigurationTypeDef:
return {
"imageExtractionConfiguration": ...,
}
# MediaExtractionConfigurationTypeDef definition
class MediaExtractionConfigurationTypeDef(TypedDict):
imageExtractionConfiguration: NotRequired[ImageExtractionConfigurationTypeDef], # (1)IndexStatisticsTypeDef#
# IndexStatisticsTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import IndexStatisticsTypeDef
def get_value() -> IndexStatisticsTypeDef:
return {
"textDocumentStatistics": ...,
}
# IndexStatisticsTypeDef definition
class IndexStatisticsTypeDef(TypedDict):
textDocumentStatistics: NotRequired[TextDocumentStatisticsTypeDef], # (1)ListIndicesResponseTypeDef#
# ListIndicesResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListIndicesResponseTypeDef
def get_value() -> ListIndicesResponseTypeDef:
return {
"nextToken": ...,
}
# ListIndicesResponseTypeDef definition
class ListIndicesResponseTypeDef(TypedDict):
indices: List[IndexTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See IndexTypeDef
- See ResponseMetadataTypeDef
ListPluginTypeMetadataResponseTypeDef#
# ListPluginTypeMetadataResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginTypeMetadataResponseTypeDef
def get_value() -> ListPluginTypeMetadataResponseTypeDef:
return {
"nextToken": ...,
}
# ListPluginTypeMetadataResponseTypeDef definition
class ListPluginTypeMetadataResponseTypeDef(TypedDict):
items: List[PluginTypeMetadataSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListPluginsResponseTypeDef#
# ListPluginsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListPluginsResponseTypeDef
def get_value() -> ListPluginsResponseTypeDef:
return {
"nextToken": ...,
}
# ListPluginsResponseTypeDef definition
class ListPluginsResponseTypeDef(TypedDict):
plugins: List[PluginTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],- See PluginTypeDef
- See ResponseMetadataTypeDef
ListRetrieversResponseTypeDef#
# ListRetrieversResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListRetrieversResponseTypeDef
def get_value() -> ListRetrieversResponseTypeDef:
return {
"retrievers": ...,
}
# ListRetrieversResponseTypeDef definition
class ListRetrieversResponseTypeDef(TypedDict):
retrievers: List[RetrieverTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListWebExperiencesResponseTypeDef#
# ListWebExperiencesResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListWebExperiencesResponseTypeDef
def get_value() -> ListWebExperiencesResponseTypeDef:
return {
"webExperiences": ...,
}
# ListWebExperiencesResponseTypeDef definition
class ListWebExperiencesResponseTypeDef(TypedDict):
webExperiences: List[WebExperienceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],PluginAuthConfigurationOutputTypeDef#
# PluginAuthConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PluginAuthConfigurationOutputTypeDef
def get_value() -> PluginAuthConfigurationOutputTypeDef:
return {
"basicAuthConfiguration": ...,
}
# PluginAuthConfigurationOutputTypeDef definition
class PluginAuthConfigurationOutputTypeDef(TypedDict):
basicAuthConfiguration: NotRequired[BasicAuthConfigurationTypeDef], # (1)
oAuth2ClientCredentialConfiguration: NotRequired[OAuth2ClientCredentialConfigurationTypeDef], # (2)
noAuthConfiguration: NotRequired[Dict[str, Any]],
idcAuthConfiguration: NotRequired[IdcAuthConfigurationTypeDef], # (3)- See BasicAuthConfigurationTypeDef
- See OAuth2ClientCredentialConfigurationTypeDef
- See IdcAuthConfigurationTypeDef
PluginAuthConfigurationTypeDef#
# PluginAuthConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PluginAuthConfigurationTypeDef
def get_value() -> PluginAuthConfigurationTypeDef:
return {
"basicAuthConfiguration": ...,
}
# PluginAuthConfigurationTypeDef definition
class PluginAuthConfigurationTypeDef(TypedDict):
basicAuthConfiguration: NotRequired[BasicAuthConfigurationTypeDef], # (1)
oAuth2ClientCredentialConfiguration: NotRequired[OAuth2ClientCredentialConfigurationTypeDef], # (2)
noAuthConfiguration: NotRequired[Mapping[str, Any]],
idcAuthConfiguration: NotRequired[IdcAuthConfigurationTypeDef], # (3)- See BasicAuthConfigurationTypeDef
- See OAuth2ClientCredentialConfigurationTypeDef
- See IdcAuthConfigurationTypeDef
PrincipalTypeDef#
# PrincipalTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PrincipalTypeDef
def get_value() -> PrincipalTypeDef:
return {
"user": ...,
}
# PrincipalTypeDef definition
class PrincipalTypeDef(TypedDict):
user: NotRequired[PrincipalUserTypeDef], # (1)
group: NotRequired[PrincipalGroupTypeDef], # (2)WebExperienceAuthConfigurationTypeDef#
# WebExperienceAuthConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import WebExperienceAuthConfigurationTypeDef
def get_value() -> WebExperienceAuthConfigurationTypeDef:
return {
"samlConfiguration": ...,
}
# WebExperienceAuthConfigurationTypeDef definition
class WebExperienceAuthConfigurationTypeDef(TypedDict):
samlConfiguration: NotRequired[SamlConfigurationTypeDef], # (1)TextSegmentTypeDef#
# TextSegmentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TextSegmentTypeDef
def get_value() -> TextSegmentTypeDef:
return {
"beginOffset": ...,
}
# TextSegmentTypeDef definition
class TextSegmentTypeDef(TypedDict):
beginOffset: NotRequired[int],
endOffset: NotRequired[int],
snippetExcerpt: NotRequired[SnippetExcerptTypeDef], # (1)
mediaId: NotRequired[str],
mediaMimeType: NotRequired[str],CustomPluginConfigurationTypeDef#
# CustomPluginConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CustomPluginConfigurationTypeDef
def get_value() -> CustomPluginConfigurationTypeDef:
return {
"description": ...,
}
# CustomPluginConfigurationTypeDef definition
class CustomPluginConfigurationTypeDef(TypedDict):
description: str,
apiSchemaType: APISchemaTypeType, # (1)
apiSchema: APISchemaTypeDef, # (2)- See APISchemaTypeType
- See APISchemaTypeDef
ActionExecutionEventTypeDef#
# ActionExecutionEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionExecutionEventTypeDef
def get_value() -> ActionExecutionEventTypeDef:
return {
"pluginId": ...,
}
# ActionExecutionEventTypeDef definition
class ActionExecutionEventTypeDef(TypedDict):
pluginId: str,
payload: Mapping[str, ActionExecutionPayloadFieldUnionTypeDef], # (1)
payloadFieldNameSeparator: str,ActionReviewEventTypeDef#
# ActionReviewEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionReviewEventTypeDef
def get_value() -> ActionReviewEventTypeDef:
return {
"conversationId": ...,
}
# ActionReviewEventTypeDef definition
class ActionReviewEventTypeDef(TypedDict):
conversationId: NotRequired[str],
userMessageId: NotRequired[str],
systemMessageId: NotRequired[str],
pluginId: NotRequired[str],
pluginType: NotRequired[PluginTypeType], # (1)
payload: NotRequired[Dict[str, ActionReviewPayloadFieldTypeDef]], # (2)
payloadFieldNameSeparator: NotRequired[str],ActionReviewTypeDef#
# ActionReviewTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionReviewTypeDef
def get_value() -> ActionReviewTypeDef:
return {
"pluginId": ...,
}
# ActionReviewTypeDef definition
class ActionReviewTypeDef(TypedDict):
pluginId: NotRequired[str],
pluginType: NotRequired[PluginTypeType], # (1)
payload: NotRequired[Dict[str, ActionReviewPayloadFieldTypeDef]], # (2)
payloadFieldNameSeparator: NotRequired[str],ListApplicationsResponseTypeDef#
# ListApplicationsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListApplicationsResponseTypeDef
def get_value() -> ListApplicationsResponseTypeDef:
return {
"nextToken": ...,
}
# ListApplicationsResponseTypeDef definition
class ListApplicationsResponseTypeDef(TypedDict):
applications: List[ApplicationTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],FailedAttachmentEventTypeDef#
# FailedAttachmentEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import FailedAttachmentEventTypeDef
def get_value() -> FailedAttachmentEventTypeDef:
return {
"conversationId": ...,
}
# FailedAttachmentEventTypeDef definition
class FailedAttachmentEventTypeDef(TypedDict):
conversationId: NotRequired[str],
userMessageId: NotRequired[str],
systemMessageId: NotRequired[str],
attachment: NotRequired[AttachmentOutputTypeDef], # (1)ListDocumentsResponseTypeDef#
# ListDocumentsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDocumentsResponseTypeDef
def get_value() -> ListDocumentsResponseTypeDef:
return {
"documentDetailList": ...,
}
# ListDocumentsResponseTypeDef definition
class ListDocumentsResponseTypeDef(TypedDict):
documentDetailList: List[DocumentDetailsTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],BatchDeleteDocumentResponseTypeDef#
# BatchDeleteDocumentResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BatchDeleteDocumentResponseTypeDef
def get_value() -> BatchDeleteDocumentResponseTypeDef:
return {
"failedDocuments": ...,
}
# BatchDeleteDocumentResponseTypeDef definition
class BatchDeleteDocumentResponseTypeDef(TypedDict):
failedDocuments: List[FailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)BatchPutDocumentResponseTypeDef#
# BatchPutDocumentResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BatchPutDocumentResponseTypeDef
def get_value() -> BatchPutDocumentResponseTypeDef:
return {
"failedDocuments": ...,
}
# BatchPutDocumentResponseTypeDef definition
class BatchPutDocumentResponseTypeDef(TypedDict):
failedDocuments: List[FailedDocumentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)GetGroupResponseTypeDef#
# GetGroupResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetGroupResponseTypeDef
def get_value() -> GetGroupResponseTypeDef:
return {
"status": ...,
}
# GetGroupResponseTypeDef definition
class GetGroupResponseTypeDef(TypedDict):
status: GroupStatusDetailTypeDef, # (1)
statusHistory: List[GroupStatusDetailTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)RuleConfigurationOutputTypeDef#
# RuleConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RuleConfigurationOutputTypeDef
def get_value() -> RuleConfigurationOutputTypeDef:
return {
"contentBlockerRule": ...,
}
# RuleConfigurationOutputTypeDef definition
class RuleConfigurationOutputTypeDef(TypedDict):
contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef], # (1)
contentRetrievalRule: NotRequired[ContentRetrievalRuleOutputTypeDef], # (2)AttachmentInputTypeDef#
# AttachmentInputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttachmentInputTypeDef
def get_value() -> AttachmentInputTypeDef:
return {
"data": ...,
}
# AttachmentInputTypeDef definition
class AttachmentInputTypeDef(TypedDict):
data: NotRequired[BlobTypeDef],
name: NotRequired[str],
copyFrom: NotRequired[CopyFromSourceTypeDef], # (1)AttachmentTypeDef#
# AttachmentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttachmentTypeDef
def get_value() -> AttachmentTypeDef:
return {
"attachmentId": ...,
}
# AttachmentTypeDef definition
class AttachmentTypeDef(TypedDict):
attachmentId: NotRequired[str],
conversationId: NotRequired[str],
name: NotRequired[str],
copyFrom: NotRequired[CopyFromSourceTypeDef], # (1)
fileType: NotRequired[str],
fileSize: NotRequired[int],
md5chksum: NotRequired[str],
createdAt: NotRequired[datetime],
status: NotRequired[AttachmentStatusType], # (2)
error: NotRequired[ErrorDetailTypeDef], # (3)ListSubscriptionsResponseTypeDef#
# ListSubscriptionsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListSubscriptionsResponseTypeDef
def get_value() -> ListSubscriptionsResponseTypeDef:
return {
"nextToken": ...,
}
# ListSubscriptionsResponseTypeDef definition
class ListSubscriptionsResponseTypeDef(TypedDict):
subscriptions: List[SubscriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ListDataSourceSyncJobsResponseTypeDef#
# ListDataSourceSyncJobsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListDataSourceSyncJobsResponseTypeDef
def get_value() -> ListDataSourceSyncJobsResponseTypeDef:
return {
"history": ...,
}
# ListDataSourceSyncJobsResponseTypeDef definition
class ListDataSourceSyncJobsResponseTypeDef(TypedDict):
history: List[DataSourceSyncJobTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],NativeIndexConfigurationOutputTypeDef#
# NativeIndexConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import NativeIndexConfigurationOutputTypeDef
def get_value() -> NativeIndexConfigurationOutputTypeDef:
return {
"indexId": ...,
}
# NativeIndexConfigurationOutputTypeDef definition
class NativeIndexConfigurationOutputTypeDef(TypedDict):
indexId: str,
boostingOverride: NotRequired[Dict[str, DocumentAttributeBoostingConfigurationOutputTypeDef]], # (1)NativeIndexConfigurationTypeDef#
# NativeIndexConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import NativeIndexConfigurationTypeDef
def get_value() -> NativeIndexConfigurationTypeDef:
return {
"indexId": ...,
}
# NativeIndexConfigurationTypeDef definition
class NativeIndexConfigurationTypeDef(TypedDict):
indexId: str,
boostingOverride: NotRequired[Mapping[str, DocumentAttributeBoostingConfigurationTypeDef]], # (1)HookConfigurationOutputTypeDef#
# HookConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import HookConfigurationOutputTypeDef
def get_value() -> HookConfigurationOutputTypeDef:
return {
"invocationCondition": ...,
}
# HookConfigurationOutputTypeDef definition
class HookConfigurationOutputTypeDef(TypedDict):
invocationCondition: NotRequired[DocumentAttributeConditionOutputTypeDef], # (1)
lambdaArn: NotRequired[str],
s3BucketName: NotRequired[str],
roleArn: NotRequired[str],AttributeFilterOutputTypeDef#
# AttributeFilterOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttributeFilterOutputTypeDef
def get_value() -> AttributeFilterOutputTypeDef:
return {
"andAllFilters": ...,
}
# AttributeFilterOutputTypeDef definition
class AttributeFilterOutputTypeDef(TypedDict):
andAllFilters: NotRequired[List[Dict[str, Any]]],
orAllFilters: NotRequired[List[Dict[str, Any]]],
notFilter: NotRequired[Dict[str, Any]],
equalsTo: NotRequired[DocumentAttributeOutputTypeDef], # (1)
containsAll: NotRequired[DocumentAttributeOutputTypeDef], # (1)
containsAny: NotRequired[DocumentAttributeOutputTypeDef], # (1)
greaterThan: NotRequired[DocumentAttributeOutputTypeDef], # (1)
greaterThanOrEquals: NotRequired[DocumentAttributeOutputTypeDef], # (1)
lessThan: NotRequired[DocumentAttributeOutputTypeDef], # (1)
lessThanOrEquals: NotRequired[DocumentAttributeOutputTypeDef], # (1)- See DocumentAttributeOutputTypeDef
- See DocumentAttributeOutputTypeDef
- See DocumentAttributeOutputTypeDef
- See DocumentAttributeOutputTypeDef
- See DocumentAttributeOutputTypeDef
- See DocumentAttributeOutputTypeDef
- See DocumentAttributeOutputTypeDef
RelevantContentTypeDef#
# RelevantContentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RelevantContentTypeDef
def get_value() -> RelevantContentTypeDef:
return {
"content": ...,
}
# RelevantContentTypeDef definition
class RelevantContentTypeDef(TypedDict):
content: NotRequired[str],
documentId: NotRequired[str],
documentTitle: NotRequired[str],
documentUri: NotRequired[str],
documentAttributes: NotRequired[List[DocumentAttributeOutputTypeDef]], # (1)
scoreAttributes: NotRequired[ScoreAttributesTypeDef], # (2)InlineDocumentEnrichmentConfigurationOutputTypeDef#
# InlineDocumentEnrichmentConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import InlineDocumentEnrichmentConfigurationOutputTypeDef
def get_value() -> InlineDocumentEnrichmentConfigurationOutputTypeDef:
return {
"condition": ...,
}
# InlineDocumentEnrichmentConfigurationOutputTypeDef definition
class InlineDocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
condition: NotRequired[DocumentAttributeConditionOutputTypeDef], # (1)
target: NotRequired[DocumentAttributeTargetOutputTypeDef], # (2)
documentContentOperator: NotRequired[DocumentContentOperatorType], # (3)- See DocumentAttributeConditionOutputTypeDef
- See DocumentAttributeTargetOutputTypeDef
- See DocumentContentOperatorType
PutFeedbackRequestTypeDef#
# PutFeedbackRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PutFeedbackRequestTypeDef
def get_value() -> PutFeedbackRequestTypeDef:
return {
"applicationId": ...,
}
# PutFeedbackRequestTypeDef definition
class PutFeedbackRequestTypeDef(TypedDict):
applicationId: str,
conversationId: str,
messageId: str,
userId: NotRequired[str],
messageCopiedAt: NotRequired[TimestampTypeDef],
messageUsefulness: NotRequired[MessageUsefulnessFeedbackTypeDef], # (1)PutGroupRequestTypeDef#
# PutGroupRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import PutGroupRequestTypeDef
def get_value() -> PutGroupRequestTypeDef:
return {
"applicationId": ...,
}
# PutGroupRequestTypeDef definition
class PutGroupRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
groupName: str,
type: MembershipTypeType, # (1)
groupMembers: GroupMembersTypeDef, # (2)
dataSourceId: NotRequired[str],
roleArn: NotRequired[str],CreateWebExperienceRequestTypeDef#
# CreateWebExperienceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateWebExperienceRequestTypeDef
def get_value() -> CreateWebExperienceRequestTypeDef:
return {
"applicationId": ...,
}
# CreateWebExperienceRequestTypeDef definition
class CreateWebExperienceRequestTypeDef(TypedDict):
applicationId: str,
title: NotRequired[str],
subtitle: NotRequired[str],
welcomeMessage: NotRequired[str],
samplePromptsControlMode: NotRequired[WebExperienceSamplePromptsControlModeType], # (1)
origins: NotRequired[Sequence[str]],
roleArn: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
clientToken: NotRequired[str],
identityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef], # (3)
browserExtensionConfiguration: NotRequired[BrowserExtensionConfigurationUnionTypeDef], # (4)
customizationConfiguration: NotRequired[CustomizationConfigurationTypeDef], # (5)- See WebExperienceSamplePromptsControlModeType
- See TagTypeDef
- See IdentityProviderConfigurationTypeDef
- See BrowserExtensionConfigurationTypeDef BrowserExtensionConfigurationOutputTypeDef
- See CustomizationConfigurationTypeDef
GetIndexResponseTypeDef#
# GetIndexResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetIndexResponseTypeDef
def get_value() -> GetIndexResponseTypeDef:
return {
"applicationId": ...,
}
# GetIndexResponseTypeDef definition
class GetIndexResponseTypeDef(TypedDict):
applicationId: str,
indexId: str,
displayName: str,
indexArn: str,
status: IndexStatusType, # (1)
type: IndexTypeType, # (2)
description: str,
createdAt: datetime,
updatedAt: datetime,
capacityConfiguration: IndexCapacityConfigurationTypeDef, # (3)
documentAttributeConfigurations: List[DocumentAttributeConfigurationTypeDef], # (4)
error: ErrorDetailTypeDef, # (5)
indexStatistics: IndexStatisticsTypeDef, # (6)
ResponseMetadata: ResponseMetadataTypeDef, # (7)- See IndexStatusType
- See IndexTypeType
- See IndexCapacityConfigurationTypeDef
- See DocumentAttributeConfigurationTypeDef
- See ErrorDetailTypeDef
- See IndexStatisticsTypeDef
- See ResponseMetadataTypeDef
AccessControlTypeDef#
# AccessControlTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AccessControlTypeDef
def get_value() -> AccessControlTypeDef:
return {
"principals": ...,
}
# AccessControlTypeDef definition
class AccessControlTypeDef(TypedDict):
principals: Sequence[PrincipalTypeDef], # (1)
memberRelation: NotRequired[MemberRelationType], # (2)- See PrincipalTypeDef
- See MemberRelationType
GetWebExperienceResponseTypeDef#
# GetWebExperienceResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetWebExperienceResponseTypeDef
def get_value() -> GetWebExperienceResponseTypeDef:
return {
"applicationId": ...,
}
# GetWebExperienceResponseTypeDef definition
class GetWebExperienceResponseTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,
webExperienceArn: str,
defaultEndpoint: str,
status: WebExperienceStatusType, # (1)
createdAt: datetime,
updatedAt: datetime,
title: str,
subtitle: str,
welcomeMessage: str,
samplePromptsControlMode: WebExperienceSamplePromptsControlModeType, # (2)
origins: List[str],
roleArn: str,
identityProviderConfiguration: IdentityProviderConfigurationTypeDef, # (3)
authenticationConfiguration: WebExperienceAuthConfigurationTypeDef, # (4)
error: ErrorDetailTypeDef, # (5)
browserExtensionConfiguration: BrowserExtensionConfigurationOutputTypeDef, # (6)
customizationConfiguration: CustomizationConfigurationTypeDef, # (7)
ResponseMetadata: ResponseMetadataTypeDef, # (8)- See WebExperienceStatusType
- See WebExperienceSamplePromptsControlModeType
- See IdentityProviderConfigurationTypeDef
- See WebExperienceAuthConfigurationTypeDef
- See ErrorDetailTypeDef
- See BrowserExtensionConfigurationOutputTypeDef
- See CustomizationConfigurationTypeDef
- See ResponseMetadataTypeDef
UpdateWebExperienceRequestTypeDef#
# UpdateWebExperienceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateWebExperienceRequestTypeDef
def get_value() -> UpdateWebExperienceRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateWebExperienceRequestTypeDef definition
class UpdateWebExperienceRequestTypeDef(TypedDict):
applicationId: str,
webExperienceId: str,
roleArn: NotRequired[str],
authenticationConfiguration: NotRequired[WebExperienceAuthConfigurationTypeDef], # (1)
title: NotRequired[str],
subtitle: NotRequired[str],
welcomeMessage: NotRequired[str],
samplePromptsControlMode: NotRequired[WebExperienceSamplePromptsControlModeType], # (2)
identityProviderConfiguration: NotRequired[IdentityProviderConfigurationTypeDef], # (3)
origins: NotRequired[Sequence[str]],
browserExtensionConfiguration: NotRequired[BrowserExtensionConfigurationUnionTypeDef], # (4)
customizationConfiguration: NotRequired[CustomizationConfigurationTypeDef], # (5)- See WebExperienceAuthConfigurationTypeDef
- See WebExperienceSamplePromptsControlModeType
- See IdentityProviderConfigurationTypeDef
- See BrowserExtensionConfigurationTypeDef BrowserExtensionConfigurationOutputTypeDef
- See CustomizationConfigurationTypeDef
SourceAttributionTypeDef#
# SourceAttributionTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SourceAttributionTypeDef
def get_value() -> SourceAttributionTypeDef:
return {
"title": ...,
}
# SourceAttributionTypeDef definition
class SourceAttributionTypeDef(TypedDict):
title: NotRequired[str],
snippet: NotRequired[str],
url: NotRequired[str],
citationNumber: NotRequired[int],
updatedAt: NotRequired[datetime],
textMessageSegments: NotRequired[List[TextSegmentTypeDef]], # (1)GetPluginResponseTypeDef#
# GetPluginResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetPluginResponseTypeDef
def get_value() -> GetPluginResponseTypeDef:
return {
"applicationId": ...,
}
# GetPluginResponseTypeDef definition
class GetPluginResponseTypeDef(TypedDict):
applicationId: str,
pluginId: str,
displayName: str,
type: PluginTypeType, # (1)
serverUrl: str,
authConfiguration: PluginAuthConfigurationOutputTypeDef, # (2)
customPluginConfiguration: CustomPluginConfigurationTypeDef, # (3)
buildStatus: PluginBuildStatusType, # (4)
pluginArn: str,
state: PluginStateType, # (5)
createdAt: datetime,
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See PluginTypeType
- See PluginAuthConfigurationOutputTypeDef
- See CustomPluginConfigurationTypeDef
- See PluginBuildStatusType
- See PluginStateType
- See ResponseMetadataTypeDef
RuleOutputTypeDef#
# RuleOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RuleOutputTypeDef
def get_value() -> RuleOutputTypeDef:
return {
"includedUsersAndGroups": ...,
}
# RuleOutputTypeDef definition
class RuleOutputTypeDef(TypedDict):
ruleType: RuleTypeType, # (3)
includedUsersAndGroups: NotRequired[UsersAndGroupsOutputTypeDef], # (1)
excludedUsersAndGroups: NotRequired[UsersAndGroupsOutputTypeDef], # (1)
ruleConfiguration: NotRequired[RuleConfigurationOutputTypeDef], # (4)- See UsersAndGroupsOutputTypeDef
- See UsersAndGroupsOutputTypeDef
- See RuleTypeType
- See RuleConfigurationOutputTypeDef
RuleConfigurationTypeDef#
# RuleConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RuleConfigurationTypeDef
def get_value() -> RuleConfigurationTypeDef:
return {
"contentBlockerRule": ...,
}
# RuleConfigurationTypeDef definition
class RuleConfigurationTypeDef(TypedDict):
contentBlockerRule: NotRequired[ContentBlockerRuleTypeDef], # (1)
contentRetrievalRule: NotRequired[ContentRetrievalRuleUnionTypeDef], # (2)AttachmentInputEventTypeDef#
# AttachmentInputEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttachmentInputEventTypeDef
def get_value() -> AttachmentInputEventTypeDef:
return {
"attachment": ...,
}
# AttachmentInputEventTypeDef definition
class AttachmentInputEventTypeDef(TypedDict):
attachment: NotRequired[AttachmentInputTypeDef], # (1)ListAttachmentsResponseTypeDef#
# ListAttachmentsResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListAttachmentsResponseTypeDef
def get_value() -> ListAttachmentsResponseTypeDef:
return {
"attachments": ...,
}
# ListAttachmentsResponseTypeDef definition
class ListAttachmentsResponseTypeDef(TypedDict):
attachments: List[AttachmentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],RetrieverConfigurationOutputTypeDef#
# RetrieverConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RetrieverConfigurationOutputTypeDef
def get_value() -> RetrieverConfigurationOutputTypeDef:
return {
"nativeIndexConfiguration": ...,
}
# RetrieverConfigurationOutputTypeDef definition
class RetrieverConfigurationOutputTypeDef(TypedDict):
nativeIndexConfiguration: NotRequired[NativeIndexConfigurationOutputTypeDef], # (1)
kendraIndexConfiguration: NotRequired[KendraIndexConfigurationTypeDef], # (2)RetrieverConfigurationTypeDef#
# RetrieverConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RetrieverConfigurationTypeDef
def get_value() -> RetrieverConfigurationTypeDef:
return {
"nativeIndexConfiguration": ...,
}
# RetrieverConfigurationTypeDef definition
class RetrieverConfigurationTypeDef(TypedDict):
nativeIndexConfiguration: NotRequired[NativeIndexConfigurationTypeDef], # (1)
kendraIndexConfiguration: NotRequired[KendraIndexConfigurationTypeDef], # (2)ActionFilterConfigurationOutputTypeDef#
# ActionFilterConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionFilterConfigurationOutputTypeDef
def get_value() -> ActionFilterConfigurationOutputTypeDef:
return {
"documentAttributeFilter": ...,
}
# ActionFilterConfigurationOutputTypeDef definition
class ActionFilterConfigurationOutputTypeDef(TypedDict):
documentAttributeFilter: AttributeFilterOutputTypeDef, # (1)SearchRelevantContentResponseTypeDef#
# SearchRelevantContentResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SearchRelevantContentResponseTypeDef
def get_value() -> SearchRelevantContentResponseTypeDef:
return {
"relevantContent": ...,
}
# SearchRelevantContentResponseTypeDef definition
class SearchRelevantContentResponseTypeDef(TypedDict):
relevantContent: List[RelevantContentTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],DocumentEnrichmentConfigurationOutputTypeDef#
# DocumentEnrichmentConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentEnrichmentConfigurationOutputTypeDef
def get_value() -> DocumentEnrichmentConfigurationOutputTypeDef:
return {
"inlineConfigurations": ...,
}
# DocumentEnrichmentConfigurationOutputTypeDef definition
class DocumentEnrichmentConfigurationOutputTypeDef(TypedDict):
inlineConfigurations: NotRequired[List[InlineDocumentEnrichmentConfigurationOutputTypeDef]], # (1)
preExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef], # (2)
postExtractionHookConfiguration: NotRequired[HookConfigurationOutputTypeDef], # (2)- See InlineDocumentEnrichmentConfigurationOutputTypeDef
- See HookConfigurationOutputTypeDef
- See HookConfigurationOutputTypeDef
DocumentAttributeConditionTypeDef#
# DocumentAttributeConditionTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeConditionTypeDef
def get_value() -> DocumentAttributeConditionTypeDef:
return {
"key": ...,
}
# DocumentAttributeConditionTypeDef definition
class DocumentAttributeConditionTypeDef(TypedDict):
key: str,
operator: DocumentEnrichmentConditionOperatorType, # (1)
value: NotRequired[DocumentAttributeValueUnionTypeDef], # (2)- See DocumentEnrichmentConditionOperatorType
- See DocumentAttributeValueTypeDef DocumentAttributeValueOutputTypeDef
DocumentAttributeTargetTypeDef#
# DocumentAttributeTargetTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeTargetTypeDef
def get_value() -> DocumentAttributeTargetTypeDef:
return {
"key": ...,
}
# DocumentAttributeTargetTypeDef definition
class DocumentAttributeTargetTypeDef(TypedDict):
key: str,
value: NotRequired[DocumentAttributeValueUnionTypeDef], # (1)
attributeValueOperator: NotRequired[AttributeValueOperatorType], # (2)- See DocumentAttributeValueTypeDef DocumentAttributeValueOutputTypeDef
- See AttributeValueOperatorType
DocumentAttributeTypeDef#
# DocumentAttributeTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentAttributeTypeDef
def get_value() -> DocumentAttributeTypeDef:
return {
"name": ...,
}
# DocumentAttributeTypeDef definition
class DocumentAttributeTypeDef(TypedDict):
name: str,
value: DocumentAttributeValueUnionTypeDef, # (1)CreatePluginRequestTypeDef#
# CreatePluginRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreatePluginRequestTypeDef
def get_value() -> CreatePluginRequestTypeDef:
return {
"applicationId": ...,
}
# CreatePluginRequestTypeDef definition
class CreatePluginRequestTypeDef(TypedDict):
applicationId: str,
displayName: str,
type: PluginTypeType, # (1)
authConfiguration: PluginAuthConfigurationUnionTypeDef, # (2)
serverUrl: NotRequired[str],
customPluginConfiguration: NotRequired[CustomPluginConfigurationTypeDef], # (3)
tags: NotRequired[Sequence[TagTypeDef]], # (4)
clientToken: NotRequired[str],- See PluginTypeType
- See PluginAuthConfigurationTypeDef PluginAuthConfigurationOutputTypeDef
- See CustomPluginConfigurationTypeDef
- See TagTypeDef
UpdatePluginRequestTypeDef#
# UpdatePluginRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdatePluginRequestTypeDef
def get_value() -> UpdatePluginRequestTypeDef:
return {
"applicationId": ...,
}
# UpdatePluginRequestTypeDef definition
class UpdatePluginRequestTypeDef(TypedDict):
applicationId: str,
pluginId: str,
displayName: NotRequired[str],
state: NotRequired[PluginStateType], # (1)
serverUrl: NotRequired[str],
customPluginConfiguration: NotRequired[CustomPluginConfigurationTypeDef], # (2)
authConfiguration: NotRequired[PluginAuthConfigurationUnionTypeDef], # (3)- See PluginStateType
- See CustomPluginConfigurationTypeDef
- See PluginAuthConfigurationTypeDef PluginAuthConfigurationOutputTypeDef
AccessConfigurationTypeDef#
# AccessConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AccessConfigurationTypeDef
def get_value() -> AccessConfigurationTypeDef:
return {
"accessControls": ...,
}
# AccessConfigurationTypeDef definition
class AccessConfigurationTypeDef(TypedDict):
accessControls: Sequence[AccessControlTypeDef], # (1)
memberRelation: NotRequired[MemberRelationType], # (2)ChatSyncOutputTypeDef#
# ChatSyncOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatSyncOutputTypeDef
def get_value() -> ChatSyncOutputTypeDef:
return {
"conversationId": ...,
}
# ChatSyncOutputTypeDef definition
class ChatSyncOutputTypeDef(TypedDict):
conversationId: str,
systemMessage: str,
systemMessageId: str,
userMessageId: str,
actionReview: ActionReviewTypeDef, # (1)
authChallengeRequest: AuthChallengeRequestTypeDef, # (2)
sourceAttributions: List[SourceAttributionTypeDef], # (3)
failedAttachments: List[AttachmentOutputTypeDef], # (4)
ResponseMetadata: ResponseMetadataTypeDef, # (5)- See ActionReviewTypeDef
- See AuthChallengeRequestTypeDef
- See SourceAttributionTypeDef
- See AttachmentOutputTypeDef
- See ResponseMetadataTypeDef
MessageTypeDef#
# MessageTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import MessageTypeDef
def get_value() -> MessageTypeDef:
return {
"messageId": ...,
}
# MessageTypeDef definition
class MessageTypeDef(TypedDict):
messageId: NotRequired[str],
body: NotRequired[str],
time: NotRequired[datetime],
type: NotRequired[MessageTypeType], # (1)
attachments: NotRequired[List[AttachmentOutputTypeDef]], # (2)
sourceAttribution: NotRequired[List[SourceAttributionTypeDef]], # (3)
actionReview: NotRequired[ActionReviewTypeDef], # (4)
actionExecution: NotRequired[ActionExecutionOutputTypeDef], # (5)- See MessageTypeType
- See AttachmentOutputTypeDef
- See SourceAttributionTypeDef
- See ActionReviewTypeDef
- See ActionExecutionOutputTypeDef
MetadataEventTypeDef#
# MetadataEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import MetadataEventTypeDef
def get_value() -> MetadataEventTypeDef:
return {
"conversationId": ...,
}
# MetadataEventTypeDef definition
class MetadataEventTypeDef(TypedDict):
conversationId: NotRequired[str],
userMessageId: NotRequired[str],
systemMessageId: NotRequired[str],
sourceAttributions: NotRequired[List[SourceAttributionTypeDef]], # (1)
finalTextMessage: NotRequired[str],TopicConfigurationOutputTypeDef#
# TopicConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TopicConfigurationOutputTypeDef
def get_value() -> TopicConfigurationOutputTypeDef:
return {
"name": ...,
}
# TopicConfigurationOutputTypeDef definition
class TopicConfigurationOutputTypeDef(TypedDict):
name: str,
rules: List[RuleOutputTypeDef], # (1)
description: NotRequired[str],
exampleChatMessages: NotRequired[List[str]],GetRetrieverResponseTypeDef#
# GetRetrieverResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetRetrieverResponseTypeDef
def get_value() -> GetRetrieverResponseTypeDef:
return {
"applicationId": ...,
}
# GetRetrieverResponseTypeDef definition
class GetRetrieverResponseTypeDef(TypedDict):
applicationId: str,
retrieverId: str,
retrieverArn: str,
type: RetrieverTypeType, # (1)
status: RetrieverStatusType, # (2)
displayName: str,
configuration: RetrieverConfigurationOutputTypeDef, # (3)
roleArn: str,
createdAt: datetime,
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (4)- See RetrieverTypeType
- See RetrieverStatusType
- See RetrieverConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
ActionConfigurationOutputTypeDef#
# ActionConfigurationOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionConfigurationOutputTypeDef
def get_value() -> ActionConfigurationOutputTypeDef:
return {
"action": ...,
}
# ActionConfigurationOutputTypeDef definition
class ActionConfigurationOutputTypeDef(TypedDict):
action: str,
filterConfiguration: NotRequired[ActionFilterConfigurationOutputTypeDef], # (1)GetDataSourceResponseTypeDef#
# GetDataSourceResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetDataSourceResponseTypeDef
def get_value() -> GetDataSourceResponseTypeDef:
return {
"applicationId": ...,
}
# GetDataSourceResponseTypeDef definition
class GetDataSourceResponseTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceId: str,
dataSourceArn: str,
displayName: str,
type: str,
configuration: Dict[str, Any],
vpcConfiguration: DataSourceVpcConfigurationOutputTypeDef, # (1)
createdAt: datetime,
updatedAt: datetime,
description: str,
status: DataSourceStatusType, # (2)
syncSchedule: str,
roleArn: str,
error: ErrorDetailTypeDef, # (3)
documentEnrichmentConfiguration: DocumentEnrichmentConfigurationOutputTypeDef, # (4)
mediaExtractionConfiguration: MediaExtractionConfigurationTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)- See DataSourceVpcConfigurationOutputTypeDef
- See DataSourceStatusType
- See ErrorDetailTypeDef
- See DocumentEnrichmentConfigurationOutputTypeDef
- See MediaExtractionConfigurationTypeDef
- See ResponseMetadataTypeDef
ListMessagesResponseTypeDef#
# ListMessagesResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ListMessagesResponseTypeDef
def get_value() -> ListMessagesResponseTypeDef:
return {
"messages": ...,
}
# ListMessagesResponseTypeDef definition
class ListMessagesResponseTypeDef(TypedDict):
messages: List[MessageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],ChatOutputStreamTypeDef#
# ChatOutputStreamTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatOutputStreamTypeDef
def get_value() -> ChatOutputStreamTypeDef:
return {
"textEvent": ...,
}
# ChatOutputStreamTypeDef definition
class ChatOutputStreamTypeDef(TypedDict):
textEvent: NotRequired[TextOutputEventTypeDef], # (1)
metadataEvent: NotRequired[MetadataEventTypeDef], # (2)
actionReviewEvent: NotRequired[ActionReviewEventTypeDef], # (3)
failedAttachmentEvent: NotRequired[FailedAttachmentEventTypeDef], # (4)
authChallengeRequestEvent: NotRequired[AuthChallengeRequestEventTypeDef], # (5)- See TextOutputEventTypeDef
- See MetadataEventTypeDef
- See ActionReviewEventTypeDef
- See FailedAttachmentEventTypeDef
- See AuthChallengeRequestEventTypeDef
GetChatControlsConfigurationResponseTypeDef#
# GetChatControlsConfigurationResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetChatControlsConfigurationResponseTypeDef
def get_value() -> GetChatControlsConfigurationResponseTypeDef:
return {
"responseScope": ...,
}
# GetChatControlsConfigurationResponseTypeDef definition
class GetChatControlsConfigurationResponseTypeDef(TypedDict):
responseScope: ResponseScopeType, # (1)
orchestrationConfiguration: AppliedOrchestrationConfigurationTypeDef, # (2)
blockedPhrases: BlockedPhrasesConfigurationTypeDef, # (3)
topicConfigurations: List[TopicConfigurationOutputTypeDef], # (4)
creatorModeConfiguration: AppliedCreatorModeConfigurationTypeDef, # (5)
ResponseMetadata: ResponseMetadataTypeDef, # (6)
nextToken: NotRequired[str],- See ResponseScopeType
- See AppliedOrchestrationConfigurationTypeDef
- See BlockedPhrasesConfigurationTypeDef
- See TopicConfigurationOutputTypeDef
- See AppliedCreatorModeConfigurationTypeDef
- See ResponseMetadataTypeDef
RuleTypeDef#
# RuleTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import RuleTypeDef
def get_value() -> RuleTypeDef:
return {
"includedUsersAndGroups": ...,
}
# RuleTypeDef definition
class RuleTypeDef(TypedDict):
ruleType: RuleTypeType, # (3)
includedUsersAndGroups: NotRequired[UsersAndGroupsUnionTypeDef], # (1)
excludedUsersAndGroups: NotRequired[UsersAndGroupsUnionTypeDef], # (1)
ruleConfiguration: NotRequired[RuleConfigurationUnionTypeDef], # (4)- See UsersAndGroupsTypeDef UsersAndGroupsOutputTypeDef
- See UsersAndGroupsTypeDef UsersAndGroupsOutputTypeDef
- See RuleTypeType
- See RuleConfigurationTypeDef RuleConfigurationOutputTypeDef
CreateRetrieverRequestTypeDef#
# CreateRetrieverRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateRetrieverRequestTypeDef
def get_value() -> CreateRetrieverRequestTypeDef:
return {
"applicationId": ...,
}
# CreateRetrieverRequestTypeDef definition
class CreateRetrieverRequestTypeDef(TypedDict):
applicationId: str,
type: RetrieverTypeType, # (1)
displayName: str,
configuration: RetrieverConfigurationUnionTypeDef, # (2)
roleArn: NotRequired[str],
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (3)- See RetrieverTypeType
- See RetrieverConfigurationTypeDef RetrieverConfigurationOutputTypeDef
- See TagTypeDef
UpdateRetrieverRequestTypeDef#
# UpdateRetrieverRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateRetrieverRequestTypeDef
def get_value() -> UpdateRetrieverRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateRetrieverRequestTypeDef definition
class UpdateRetrieverRequestTypeDef(TypedDict):
applicationId: str,
retrieverId: str,
configuration: NotRequired[RetrieverConfigurationUnionTypeDef], # (1)
displayName: NotRequired[str],
roleArn: NotRequired[str],GetDataAccessorResponseTypeDef#
# GetDataAccessorResponseTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import GetDataAccessorResponseTypeDef
def get_value() -> GetDataAccessorResponseTypeDef:
return {
"displayName": ...,
}
# GetDataAccessorResponseTypeDef definition
class GetDataAccessorResponseTypeDef(TypedDict):
displayName: str,
dataAccessorId: str,
dataAccessorArn: str,
applicationId: str,
idcApplicationArn: str,
principal: str,
actionConfigurations: List[ActionConfigurationOutputTypeDef], # (1)
createdAt: datetime,
updatedAt: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)HookConfigurationTypeDef#
# HookConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import HookConfigurationTypeDef
def get_value() -> HookConfigurationTypeDef:
return {
"invocationCondition": ...,
}
# HookConfigurationTypeDef definition
class HookConfigurationTypeDef(TypedDict):
invocationCondition: NotRequired[DocumentAttributeConditionUnionTypeDef], # (1)
lambdaArn: NotRequired[str],
s3BucketName: NotRequired[str],
roleArn: NotRequired[str],InlineDocumentEnrichmentConfigurationTypeDef#
# InlineDocumentEnrichmentConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import InlineDocumentEnrichmentConfigurationTypeDef
def get_value() -> InlineDocumentEnrichmentConfigurationTypeDef:
return {
"condition": ...,
}
# InlineDocumentEnrichmentConfigurationTypeDef definition
class InlineDocumentEnrichmentConfigurationTypeDef(TypedDict):
condition: NotRequired[DocumentAttributeConditionUnionTypeDef], # (1)
target: NotRequired[DocumentAttributeTargetUnionTypeDef], # (2)
documentContentOperator: NotRequired[DocumentContentOperatorType], # (3)- See DocumentAttributeConditionTypeDef DocumentAttributeConditionOutputTypeDef
- See DocumentAttributeTargetTypeDef DocumentAttributeTargetOutputTypeDef
- See DocumentContentOperatorType
AttributeFilterPaginatorTypeDef#
# AttributeFilterPaginatorTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttributeFilterPaginatorTypeDef
def get_value() -> AttributeFilterPaginatorTypeDef:
return {
"andAllFilters": ...,
}
# AttributeFilterPaginatorTypeDef definition
class AttributeFilterPaginatorTypeDef(TypedDict):
andAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
orAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
notFilter: NotRequired[Mapping[str, Any]],
equalsTo: NotRequired[DocumentAttributeUnionTypeDef], # (1)
containsAll: NotRequired[DocumentAttributeUnionTypeDef], # (1)
containsAny: NotRequired[DocumentAttributeUnionTypeDef], # (1)
greaterThan: NotRequired[DocumentAttributeUnionTypeDef], # (1)
greaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef], # (1)
lessThan: NotRequired[DocumentAttributeUnionTypeDef], # (1)
lessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef], # (1)- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
AttributeFilterTypeDef#
# AttributeFilterTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import AttributeFilterTypeDef
def get_value() -> AttributeFilterTypeDef:
return {
"andAllFilters": ...,
}
# AttributeFilterTypeDef definition
class AttributeFilterTypeDef(TypedDict):
andAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
orAllFilters: NotRequired[Sequence[Mapping[str, Any]]],
notFilter: NotRequired[Mapping[str, Any]],
equalsTo: NotRequired[DocumentAttributeUnionTypeDef], # (1)
containsAll: NotRequired[DocumentAttributeUnionTypeDef], # (1)
containsAny: NotRequired[DocumentAttributeUnionTypeDef], # (1)
greaterThan: NotRequired[DocumentAttributeUnionTypeDef], # (1)
greaterThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef], # (1)
lessThan: NotRequired[DocumentAttributeUnionTypeDef], # (1)
lessThanOrEquals: NotRequired[DocumentAttributeUnionTypeDef], # (1)- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
ChatOutputTypeDef#
# ChatOutputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatOutputTypeDef
def get_value() -> ChatOutputTypeDef:
return {
"outputStream": ...,
}
# ChatOutputTypeDef definition
class ChatOutputTypeDef(TypedDict):
outputStream: EventStream[ChatOutputStreamTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)SearchRelevantContentRequestPaginateTypeDef#
# SearchRelevantContentRequestPaginateTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SearchRelevantContentRequestPaginateTypeDef
def get_value() -> SearchRelevantContentRequestPaginateTypeDef:
return {
"applicationId": ...,
}
# SearchRelevantContentRequestPaginateTypeDef definition
class SearchRelevantContentRequestPaginateTypeDef(TypedDict):
applicationId: str,
queryText: str,
contentSource: ContentSourceTypeDef, # (1)
attributeFilter: NotRequired[AttributeFilterPaginatorTypeDef], # (2)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (3)TopicConfigurationTypeDef#
# TopicConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import TopicConfigurationTypeDef
def get_value() -> TopicConfigurationTypeDef:
return {
"name": ...,
}
# TopicConfigurationTypeDef definition
class TopicConfigurationTypeDef(TypedDict):
name: str,
rules: Sequence[RuleUnionTypeDef], # (1)
description: NotRequired[str],
exampleChatMessages: NotRequired[Sequence[str]],DocumentEnrichmentConfigurationTypeDef#
# DocumentEnrichmentConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentEnrichmentConfigurationTypeDef
def get_value() -> DocumentEnrichmentConfigurationTypeDef:
return {
"inlineConfigurations": ...,
}
# DocumentEnrichmentConfigurationTypeDef definition
class DocumentEnrichmentConfigurationTypeDef(TypedDict):
inlineConfigurations: NotRequired[Sequence[InlineDocumentEnrichmentConfigurationUnionTypeDef]], # (1)
preExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef], # (2)
postExtractionHookConfiguration: NotRequired[HookConfigurationUnionTypeDef], # (2)- See InlineDocumentEnrichmentConfigurationTypeDef InlineDocumentEnrichmentConfigurationOutputTypeDef
- See HookConfigurationTypeDef HookConfigurationOutputTypeDef
- See HookConfigurationTypeDef HookConfigurationOutputTypeDef
ActionFilterConfigurationTypeDef#
# ActionFilterConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionFilterConfigurationTypeDef
def get_value() -> ActionFilterConfigurationTypeDef:
return {
"documentAttributeFilter": ...,
}
# ActionFilterConfigurationTypeDef definition
class ActionFilterConfigurationTypeDef(TypedDict):
documentAttributeFilter: AttributeFilterUnionTypeDef, # (1)ChatSyncInputTypeDef#
# ChatSyncInputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatSyncInputTypeDef
def get_value() -> ChatSyncInputTypeDef:
return {
"applicationId": ...,
}
# ChatSyncInputTypeDef definition
class ChatSyncInputTypeDef(TypedDict):
applicationId: str,
userId: NotRequired[str],
userGroups: NotRequired[Sequence[str]],
userMessage: NotRequired[str],
attachments: NotRequired[Sequence[AttachmentInputTypeDef]], # (1)
actionExecution: NotRequired[ActionExecutionUnionTypeDef], # (2)
authChallengeResponse: NotRequired[AuthChallengeResponseTypeDef], # (3)
conversationId: NotRequired[str],
parentMessageId: NotRequired[str],
attributeFilter: NotRequired[AttributeFilterUnionTypeDef], # (4)
chatMode: NotRequired[ChatModeType], # (5)
chatModeConfiguration: NotRequired[ChatModeConfigurationTypeDef], # (6)
clientToken: NotRequired[str],- See AttachmentInputTypeDef
- See ActionExecutionTypeDef ActionExecutionOutputTypeDef
- See AuthChallengeResponseTypeDef
- See AttributeFilterTypeDef AttributeFilterOutputTypeDef
- See ChatModeType
- See ChatModeConfigurationTypeDef
ConfigurationEventTypeDef#
# ConfigurationEventTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ConfigurationEventTypeDef
def get_value() -> ConfigurationEventTypeDef:
return {
"chatMode": ...,
}
# ConfigurationEventTypeDef definition
class ConfigurationEventTypeDef(TypedDict):
chatMode: NotRequired[ChatModeType], # (1)
chatModeConfiguration: NotRequired[ChatModeConfigurationTypeDef], # (2)
attributeFilter: NotRequired[AttributeFilterUnionTypeDef], # (3)- See ChatModeType
- See ChatModeConfigurationTypeDef
- See AttributeFilterTypeDef AttributeFilterOutputTypeDef
SearchRelevantContentRequestTypeDef#
# SearchRelevantContentRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import SearchRelevantContentRequestTypeDef
def get_value() -> SearchRelevantContentRequestTypeDef:
return {
"applicationId": ...,
}
# SearchRelevantContentRequestTypeDef definition
class SearchRelevantContentRequestTypeDef(TypedDict):
applicationId: str,
queryText: str,
contentSource: ContentSourceTypeDef, # (1)
attributeFilter: NotRequired[AttributeFilterUnionTypeDef], # (2)
maxResults: NotRequired[int],
nextToken: NotRequired[str],ChatInputStreamTypeDef#
# ChatInputStreamTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatInputStreamTypeDef
def get_value() -> ChatInputStreamTypeDef:
return {
"configurationEvent": ...,
}
# ChatInputStreamTypeDef definition
class ChatInputStreamTypeDef(TypedDict):
configurationEvent: NotRequired[ConfigurationEventTypeDef], # (1)
textEvent: NotRequired[TextInputEventTypeDef], # (2)
attachmentEvent: NotRequired[AttachmentInputEventTypeDef], # (3)
actionExecutionEvent: NotRequired[ActionExecutionEventTypeDef], # (4)
endOfInputEvent: NotRequired[Mapping[str, Any]],
authChallengeResponseEvent: NotRequired[AuthChallengeResponseEventTypeDef], # (5)- See ConfigurationEventTypeDef
- See TextInputEventTypeDef
- See AttachmentInputEventTypeDef
- See ActionExecutionEventTypeDef
- See AuthChallengeResponseEventTypeDef
UpdateChatControlsConfigurationRequestTypeDef#
# UpdateChatControlsConfigurationRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateChatControlsConfigurationRequestTypeDef
def get_value() -> UpdateChatControlsConfigurationRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateChatControlsConfigurationRequestTypeDef definition
class UpdateChatControlsConfigurationRequestTypeDef(TypedDict):
applicationId: str,
clientToken: NotRequired[str],
responseScope: NotRequired[ResponseScopeType], # (1)
orchestrationConfiguration: NotRequired[OrchestrationConfigurationTypeDef], # (2)
blockedPhrasesConfigurationUpdate: NotRequired[BlockedPhrasesConfigurationUpdateTypeDef], # (3)
topicConfigurationsToCreateOrUpdate: NotRequired[Sequence[TopicConfigurationUnionTypeDef]], # (4)
topicConfigurationsToDelete: NotRequired[Sequence[TopicConfigurationUnionTypeDef]], # (4)
creatorModeConfiguration: NotRequired[CreatorModeConfigurationTypeDef], # (6)- See ResponseScopeType
- See OrchestrationConfigurationTypeDef
- See BlockedPhrasesConfigurationUpdateTypeDef
- See TopicConfigurationTypeDef TopicConfigurationOutputTypeDef
- See TopicConfigurationTypeDef TopicConfigurationOutputTypeDef
- See CreatorModeConfigurationTypeDef
CreateDataSourceRequestTypeDef#
# CreateDataSourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateDataSourceRequestTypeDef
def get_value() -> CreateDataSourceRequestTypeDef:
return {
"applicationId": ...,
}
# CreateDataSourceRequestTypeDef definition
class CreateDataSourceRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
displayName: str,
configuration: Mapping[str, Any],
vpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef], # (1)
description: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)
syncSchedule: NotRequired[str],
roleArn: NotRequired[str],
clientToken: NotRequired[str],
documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationUnionTypeDef], # (3)
mediaExtractionConfiguration: NotRequired[MediaExtractionConfigurationTypeDef], # (4)- See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef
- See TagTypeDef
- See DocumentEnrichmentConfigurationTypeDef DocumentEnrichmentConfigurationOutputTypeDef
- See MediaExtractionConfigurationTypeDef
DocumentTypeDef#
# DocumentTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import DocumentTypeDef
def get_value() -> DocumentTypeDef:
return {
"id": ...,
}
# DocumentTypeDef definition
class DocumentTypeDef(TypedDict):
id: str,
attributes: NotRequired[Sequence[DocumentAttributeUnionTypeDef]], # (1)
content: NotRequired[DocumentContentTypeDef], # (2)
contentType: NotRequired[ContentTypeType], # (3)
title: NotRequired[str],
accessConfiguration: NotRequired[AccessConfigurationTypeDef], # (4)
documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationUnionTypeDef], # (5)
mediaExtractionConfiguration: NotRequired[MediaExtractionConfigurationTypeDef], # (6)- See DocumentAttributeTypeDef DocumentAttributeOutputTypeDef
- See DocumentContentTypeDef
- See ContentTypeType
- See AccessConfigurationTypeDef
- See DocumentEnrichmentConfigurationTypeDef DocumentEnrichmentConfigurationOutputTypeDef
- See MediaExtractionConfigurationTypeDef
UpdateDataSourceRequestTypeDef#
# UpdateDataSourceRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateDataSourceRequestTypeDef
def get_value() -> UpdateDataSourceRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateDataSourceRequestTypeDef definition
class UpdateDataSourceRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
dataSourceId: str,
displayName: NotRequired[str],
configuration: NotRequired[Mapping[str, Any]],
vpcConfiguration: NotRequired[DataSourceVpcConfigurationUnionTypeDef], # (1)
description: NotRequired[str],
syncSchedule: NotRequired[str],
roleArn: NotRequired[str],
documentEnrichmentConfiguration: NotRequired[DocumentEnrichmentConfigurationUnionTypeDef], # (2)
mediaExtractionConfiguration: NotRequired[MediaExtractionConfigurationTypeDef], # (3)- See DataSourceVpcConfigurationTypeDef DataSourceVpcConfigurationOutputTypeDef
- See DocumentEnrichmentConfigurationTypeDef DocumentEnrichmentConfigurationOutputTypeDef
- See MediaExtractionConfigurationTypeDef
ActionConfigurationTypeDef#
# ActionConfigurationTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ActionConfigurationTypeDef
def get_value() -> ActionConfigurationTypeDef:
return {
"action": ...,
}
# ActionConfigurationTypeDef definition
class ActionConfigurationTypeDef(TypedDict):
action: str,
filterConfiguration: NotRequired[ActionFilterConfigurationUnionTypeDef], # (1)ChatInputTypeDef#
# ChatInputTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import ChatInputTypeDef
def get_value() -> ChatInputTypeDef:
return {
"applicationId": ...,
}
# ChatInputTypeDef definition
class ChatInputTypeDef(TypedDict):
applicationId: str,
userId: NotRequired[str],
userGroups: NotRequired[Sequence[str]],
conversationId: NotRequired[str],
parentMessageId: NotRequired[str],
clientToken: NotRequired[str],
inputStream: NotRequired[EventStream[ChatInputStreamTypeDef]], # (1)BatchPutDocumentRequestTypeDef#
# BatchPutDocumentRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import BatchPutDocumentRequestTypeDef
def get_value() -> BatchPutDocumentRequestTypeDef:
return {
"applicationId": ...,
}
# BatchPutDocumentRequestTypeDef definition
class BatchPutDocumentRequestTypeDef(TypedDict):
applicationId: str,
indexId: str,
documents: Sequence[DocumentTypeDef], # (1)
roleArn: NotRequired[str],
dataSourceSyncId: NotRequired[str],- See DocumentTypeDef
CreateDataAccessorRequestTypeDef#
# CreateDataAccessorRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import CreateDataAccessorRequestTypeDef
def get_value() -> CreateDataAccessorRequestTypeDef:
return {
"applicationId": ...,
}
# CreateDataAccessorRequestTypeDef definition
class CreateDataAccessorRequestTypeDef(TypedDict):
applicationId: str,
principal: str,
actionConfigurations: Sequence[ActionConfigurationUnionTypeDef], # (1)
displayName: str,
clientToken: NotRequired[str],
tags: NotRequired[Sequence[TagTypeDef]], # (2)UpdateDataAccessorRequestTypeDef#
# UpdateDataAccessorRequestTypeDef TypedDict usage example
from types_boto3_qbusiness.type_defs import UpdateDataAccessorRequestTypeDef
def get_value() -> UpdateDataAccessorRequestTypeDef:
return {
"applicationId": ...,
}
# UpdateDataAccessorRequestTypeDef definition
class UpdateDataAccessorRequestTypeDef(TypedDict):
applicationId: str,
dataAccessorId: str,
actionConfigurations: Sequence[ActionConfigurationUnionTypeDef], # (1)
displayName: NotRequired[str],