Type definitions#
Auto-generated documentation for QApps type annotations stubs module mypy-boto3-qapps.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
AppDefinitionInputUnionTypeDef#
# AppDefinitionInputUnionTypeDef definition
AppDefinitionInputUnionTypeDef = Union[
AppDefinitionInputTypeDef, # (1)
AppDefinitionInputOutputTypeDef, # (2)
]
AssociateLibraryItemReviewInputRequestTypeDef#
# AssociateLibraryItemReviewInputRequestTypeDef definition
class AssociateLibraryItemReviewInputRequestTypeDef(TypedDict):
instanceId: str,
libraryItemId: str,
AssociateQAppWithUserInputRequestTypeDef#
# AssociateQAppWithUserInputRequestTypeDef definition
class AssociateQAppWithUserInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
FileUploadCardInputTypeDef#
# FileUploadCardInputTypeDef definition
class FileUploadCardInputTypeDef(TypedDict):
title: str,
id: str,
type: CardTypeType, # (1)
filename: NotRequired[str],
fileId: NotRequired[str],
allowOverride: NotRequired[bool],
- See CardTypeType
QPluginCardInputTypeDef#
# QPluginCardInputTypeDef definition
class QPluginCardInputTypeDef(TypedDict):
title: str,
id: str,
type: CardTypeType, # (1)
prompt: str,
pluginId: str,
- See CardTypeType
QQueryCardInputTypeDef#
# QQueryCardInputTypeDef definition
class QQueryCardInputTypeDef(TypedDict):
title: str,
id: str,
type: CardTypeType, # (1)
prompt: str,
outputSource: NotRequired[CardOutputSourceType], # (2)
attributeFilter: NotRequired[AttributeFilterTypeDef], # (3)
- See CardTypeType
- See CardOutputSourceType
- See AttributeFilterTypeDef
TextInputCardInputTypeDef#
# TextInputCardInputTypeDef definition
class TextInputCardInputTypeDef(TypedDict):
title: str,
id: str,
type: CardTypeType, # (1)
placeholder: NotRequired[str],
defaultValue: NotRequired[str],
- See CardTypeType
CardStatusTypeDef#
# CardStatusTypeDef definition
class CardStatusTypeDef(TypedDict):
currentState: ExecutionStatusType, # (1)
currentValue: str,
FileUploadCardTypeDef#
# FileUploadCardTypeDef definition
class FileUploadCardTypeDef(TypedDict):
id: str,
title: str,
dependencies: List[str],
type: CardTypeType, # (1)
filename: NotRequired[str],
fileId: NotRequired[str],
allowOverride: NotRequired[bool],
- See CardTypeType
QPluginCardTypeDef#
# QPluginCardTypeDef definition
class QPluginCardTypeDef(TypedDict):
id: str,
title: str,
dependencies: List[str],
type: CardTypeType, # (1)
prompt: str,
pluginType: PluginTypeType, # (2)
pluginId: str,
- See CardTypeType
- See PluginTypeType
QQueryCardTypeDef#
# QQueryCardTypeDef definition
class QQueryCardTypeDef(TypedDict):
id: str,
title: str,
dependencies: List[str],
type: CardTypeType, # (1)
prompt: str,
outputSource: CardOutputSourceType, # (2)
attributeFilter: NotRequired[AttributeFilterOutputTypeDef], # (3)
TextInputCardTypeDef#
# TextInputCardTypeDef definition
class TextInputCardTypeDef(TypedDict):
id: str,
title: str,
dependencies: List[str],
type: CardTypeType, # (1)
placeholder: NotRequired[str],
defaultValue: NotRequired[str],
- See CardTypeType
CardValueTypeDef#
# CardValueTypeDef definition
class CardValueTypeDef(TypedDict):
cardId: str,
value: str,
CategoryTypeDef#
# CategoryTypeDef definition
class CategoryTypeDef(TypedDict):
id: str,
title: str,
ConversationMessageTypeDef#
# ConversationMessageTypeDef definition
class ConversationMessageTypeDef(TypedDict):
body: str,
type: SenderType, # (1)
- See SenderType
CreateLibraryItemInputRequestTypeDef#
# CreateLibraryItemInputRequestTypeDef definition
class CreateLibraryItemInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
appVersion: int,
categories: Sequence[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DeleteLibraryItemInputRequestTypeDef#
# DeleteLibraryItemInputRequestTypeDef definition
class DeleteLibraryItemInputRequestTypeDef(TypedDict):
instanceId: str,
libraryItemId: str,
DeleteQAppInputRequestTypeDef#
# DeleteQAppInputRequestTypeDef definition
class DeleteQAppInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
DisassociateLibraryItemReviewInputRequestTypeDef#
# DisassociateLibraryItemReviewInputRequestTypeDef definition
class DisassociateLibraryItemReviewInputRequestTypeDef(TypedDict):
instanceId: str,
libraryItemId: str,
DisassociateQAppFromUserInputRequestTypeDef#
# DisassociateQAppFromUserInputRequestTypeDef definition
class DisassociateQAppFromUserInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
DocumentAttributeValueOutputTypeDef#
# DocumentAttributeValueOutputTypeDef definition
class DocumentAttributeValueOutputTypeDef(TypedDict):
stringValue: NotRequired[str],
stringListValue: NotRequired[List[str]],
longValue: NotRequired[int],
dateValue: NotRequired[datetime],
GetLibraryItemInputRequestTypeDef#
# GetLibraryItemInputRequestTypeDef definition
class GetLibraryItemInputRequestTypeDef(TypedDict):
instanceId: str,
libraryItemId: str,
appId: NotRequired[str],
GetQAppInputRequestTypeDef#
# GetQAppInputRequestTypeDef definition
class GetQAppInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
GetQAppSessionInputRequestTypeDef#
# GetQAppSessionInputRequestTypeDef definition
class GetQAppSessionInputRequestTypeDef(TypedDict):
instanceId: str,
sessionId: str,
ImportDocumentInputRequestTypeDef#
# ImportDocumentInputRequestTypeDef definition
class ImportDocumentInputRequestTypeDef(TypedDict):
instanceId: str,
cardId: str,
appId: str,
fileContentsBase64: str,
fileName: str,
scope: DocumentScopeType, # (1)
sessionId: NotRequired[str],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListLibraryItemsInputRequestTypeDef#
# ListLibraryItemsInputRequestTypeDef definition
class ListLibraryItemsInputRequestTypeDef(TypedDict):
instanceId: str,
limit: NotRequired[int],
nextToken: NotRequired[str],
categoryId: NotRequired[str],
ListQAppsInputRequestTypeDef#
# ListQAppsInputRequestTypeDef definition
class ListQAppsInputRequestTypeDef(TypedDict):
instanceId: str,
limit: NotRequired[int],
nextToken: NotRequired[str],
UserAppItemTypeDef#
# UserAppItemTypeDef definition
class UserAppItemTypeDef(TypedDict):
appId: str,
appArn: str,
title: str,
createdAt: datetime,
description: NotRequired[str],
canEdit: NotRequired[bool],
status: NotRequired[str],
isVerified: NotRequired[bool],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
StopQAppSessionInputRequestTypeDef#
# StopQAppSessionInputRequestTypeDef definition
class StopQAppSessionInputRequestTypeDef(TypedDict):
instanceId: str,
sessionId: str,
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceARN: str,
tagKeys: Sequence[str],
UpdateLibraryItemInputRequestTypeDef#
# UpdateLibraryItemInputRequestTypeDef definition
class UpdateLibraryItemInputRequestTypeDef(TypedDict):
instanceId: str,
libraryItemId: str,
status: NotRequired[LibraryItemStatusType], # (1)
categories: NotRequired[Sequence[str]],
UpdateLibraryItemMetadataInputRequestTypeDef#
# UpdateLibraryItemMetadataInputRequestTypeDef definition
class UpdateLibraryItemMetadataInputRequestTypeDef(TypedDict):
instanceId: str,
libraryItemId: str,
isVerified: NotRequired[bool],
CardInputTypeDef#
# CardInputTypeDef definition
class CardInputTypeDef(TypedDict):
textInput: NotRequired[TextInputCardInputTypeDef], # (1)
qQuery: NotRequired[QQueryCardInputTypeDef], # (2)
qPlugin: NotRequired[QPluginCardInputTypeDef], # (3)
fileUpload: NotRequired[FileUploadCardInputTypeDef], # (4)
- See TextInputCardInputTypeDef
- See QQueryCardInputTypeDef
- See QPluginCardInputTypeDef
- See FileUploadCardInputTypeDef
CardTypeDef#
# CardTypeDef definition
class CardTypeDef(TypedDict):
textInput: NotRequired[TextInputCardTypeDef], # (1)
qQuery: NotRequired[QQueryCardTypeDef], # (2)
qPlugin: NotRequired[QPluginCardTypeDef], # (3)
fileUpload: NotRequired[FileUploadCardTypeDef], # (4)
- See TextInputCardTypeDef
- See QQueryCardTypeDef
- See QPluginCardTypeDef
- See FileUploadCardTypeDef
StartQAppSessionInputRequestTypeDef#
# StartQAppSessionInputRequestTypeDef definition
class StartQAppSessionInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
appVersion: int,
initialValues: NotRequired[Sequence[CardValueTypeDef]], # (1)
tags: NotRequired[Mapping[str, str]],
- See CardValueTypeDef
UpdateQAppSessionInputRequestTypeDef#
# UpdateQAppSessionInputRequestTypeDef definition
class UpdateQAppSessionInputRequestTypeDef(TypedDict):
instanceId: str,
sessionId: str,
values: NotRequired[Sequence[CardValueTypeDef]], # (1)
- See CardValueTypeDef
LibraryItemMemberTypeDef#
# LibraryItemMemberTypeDef definition
class LibraryItemMemberTypeDef(TypedDict):
libraryItemId: str,
appId: str,
appVersion: int,
categories: List[CategoryTypeDef], # (1)
status: str,
createdAt: datetime,
createdBy: str,
ratingCount: int,
updatedAt: NotRequired[datetime],
updatedBy: NotRequired[str],
isRatedByUser: NotRequired[bool],
userCount: NotRequired[int],
isVerified: NotRequired[bool],
- See CategoryTypeDef
PredictQAppInputOptionsTypeDef#
# PredictQAppInputOptionsTypeDef definition
class PredictQAppInputOptionsTypeDef(TypedDict):
conversation: NotRequired[Sequence[ConversationMessageTypeDef]], # (1)
problemStatement: NotRequired[str],
CreateLibraryItemOutputTypeDef#
# CreateLibraryItemOutputTypeDef definition
class CreateLibraryItemOutputTypeDef(TypedDict):
libraryItemId: str,
status: str,
createdAt: datetime,
createdBy: str,
updatedAt: datetime,
updatedBy: str,
ratingCount: int,
isVerified: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateQAppOutputTypeDef#
# CreateQAppOutputTypeDef definition
class CreateQAppOutputTypeDef(TypedDict):
appId: str,
appArn: str,
title: str,
description: str,
initialPrompt: str,
appVersion: int,
status: AppStatusType, # (1)
createdAt: datetime,
createdBy: str,
updatedAt: datetime,
updatedBy: str,
requiredCapabilities: List[AppRequiredCapabilityType], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetLibraryItemOutputTypeDef#
# GetLibraryItemOutputTypeDef definition
class GetLibraryItemOutputTypeDef(TypedDict):
libraryItemId: str,
appId: str,
appVersion: int,
categories: List[CategoryTypeDef], # (1)
status: str,
createdAt: datetime,
createdBy: str,
updatedAt: datetime,
updatedBy: str,
ratingCount: int,
isRatedByUser: bool,
userCount: int,
isVerified: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetQAppSessionOutputTypeDef#
# GetQAppSessionOutputTypeDef definition
class GetQAppSessionOutputTypeDef(TypedDict):
sessionId: str,
sessionArn: str,
status: ExecutionStatusType, # (1)
cardStatus: Dict[str, CardStatusTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
ImportDocumentOutputTypeDef#
# ImportDocumentOutputTypeDef definition
class ImportDocumentOutputTypeDef(TypedDict):
fileId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
StartQAppSessionOutputTypeDef#
# StartQAppSessionOutputTypeDef definition
class StartQAppSessionOutputTypeDef(TypedDict):
sessionId: str,
sessionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateLibraryItemOutputTypeDef#
# UpdateLibraryItemOutputTypeDef definition
class UpdateLibraryItemOutputTypeDef(TypedDict):
libraryItemId: str,
appId: str,
appVersion: int,
categories: List[CategoryTypeDef], # (1)
status: str,
createdAt: datetime,
createdBy: str,
updatedAt: datetime,
updatedBy: str,
ratingCount: int,
isRatedByUser: bool,
userCount: int,
isVerified: bool,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateQAppOutputTypeDef#
# UpdateQAppOutputTypeDef definition
class UpdateQAppOutputTypeDef(TypedDict):
appId: str,
appArn: str,
title: str,
description: str,
initialPrompt: str,
appVersion: int,
status: AppStatusType, # (1)
createdAt: datetime,
createdBy: str,
updatedAt: datetime,
updatedBy: str,
requiredCapabilities: List[AppRequiredCapabilityType], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
UpdateQAppSessionOutputTypeDef#
# UpdateQAppSessionOutputTypeDef definition
class UpdateQAppSessionOutputTypeDef(TypedDict):
sessionId: str,
sessionArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DocumentAttributeOutputTypeDef#
# DocumentAttributeOutputTypeDef definition
class DocumentAttributeOutputTypeDef(TypedDict):
name: str,
value: DocumentAttributeValueOutputTypeDef, # (1)
DocumentAttributeValueTypeDef#
# DocumentAttributeValueTypeDef definition
class DocumentAttributeValueTypeDef(TypedDict):
stringValue: NotRequired[str],
stringListValue: NotRequired[Sequence[str]],
longValue: NotRequired[int],
dateValue: NotRequired[Union[datetime, str]],
ListLibraryItemsInputListLibraryItemsPaginateTypeDef#
# ListLibraryItemsInputListLibraryItemsPaginateTypeDef definition
class ListLibraryItemsInputListLibraryItemsPaginateTypeDef(TypedDict):
instanceId: str,
categoryId: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQAppsInputListQAppsPaginateTypeDef#
# ListQAppsInputListQAppsPaginateTypeDef definition
class ListQAppsInputListQAppsPaginateTypeDef(TypedDict):
instanceId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListQAppsOutputTypeDef#
# ListQAppsOutputTypeDef definition
class ListQAppsOutputTypeDef(TypedDict):
apps: List[UserAppItemTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AppDefinitionInputOutputTypeDef#
# AppDefinitionInputOutputTypeDef definition
class AppDefinitionInputOutputTypeDef(TypedDict):
cards: List[CardInputTypeDef], # (1)
initialPrompt: NotRequired[str],
- See CardInputTypeDef
AppDefinitionInputTypeDef#
# AppDefinitionInputTypeDef definition
class AppDefinitionInputTypeDef(TypedDict):
cards: Sequence[CardInputTypeDef], # (1)
initialPrompt: NotRequired[str],
- See CardInputTypeDef
AppDefinitionTypeDef#
# AppDefinitionTypeDef definition
class AppDefinitionTypeDef(TypedDict):
appDefinitionVersion: str,
cards: List[CardTypeDef], # (1)
canEdit: NotRequired[bool],
- See CardTypeDef
ListLibraryItemsOutputTypeDef#
# ListLibraryItemsOutputTypeDef definition
class ListLibraryItemsOutputTypeDef(TypedDict):
libraryItems: List[LibraryItemMemberTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PredictQAppInputRequestTypeDef#
# PredictQAppInputRequestTypeDef definition
class PredictQAppInputRequestTypeDef(TypedDict):
instanceId: str,
options: NotRequired[PredictQAppInputOptionsTypeDef], # (1)
AttributeFilterOutputTypeDef#
# 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
DocumentAttributeTypeDef#
# DocumentAttributeTypeDef definition
class DocumentAttributeTypeDef(TypedDict):
name: str,
value: DocumentAttributeValueTypeDef, # (1)
PredictAppDefinitionTypeDef#
# PredictAppDefinitionTypeDef definition
class PredictAppDefinitionTypeDef(TypedDict):
title: str,
appDefinition: AppDefinitionInputOutputTypeDef, # (1)
description: NotRequired[str],
CreateQAppInputRequestTypeDef#
# CreateQAppInputRequestTypeDef definition
class CreateQAppInputRequestTypeDef(TypedDict):
instanceId: str,
title: str,
appDefinition: AppDefinitionInputTypeDef, # (1)
description: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
UpdateQAppInputRequestTypeDef#
# UpdateQAppInputRequestTypeDef definition
class UpdateQAppInputRequestTypeDef(TypedDict):
instanceId: str,
appId: str,
title: NotRequired[str],
description: NotRequired[str],
appDefinition: NotRequired[AppDefinitionInputTypeDef], # (1)
GetQAppOutputTypeDef#
# GetQAppOutputTypeDef definition
class GetQAppOutputTypeDef(TypedDict):
appId: str,
appArn: str,
title: str,
description: str,
initialPrompt: str,
appVersion: int,
status: AppStatusType, # (1)
createdAt: datetime,
createdBy: str,
updatedAt: datetime,
updatedBy: str,
requiredCapabilities: List[AppRequiredCapabilityType], # (2)
appDefinition: AppDefinitionTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AppStatusType
- See AppRequiredCapabilityType
- See AppDefinitionTypeDef
- See ResponseMetadataTypeDef
AttributeFilterTypeDef#
# AttributeFilterTypeDef definition
class AttributeFilterTypeDef(TypedDict):
andAllFilters: NotRequired[Sequence[Dict[str, Any]]],
orAllFilters: NotRequired[Sequence[Dict[str, Any]]],
notFilter: NotRequired[Dict[str, Any]],
equalsTo: NotRequired[DocumentAttributeTypeDef], # (1)
containsAll: NotRequired[DocumentAttributeTypeDef], # (1)
containsAny: NotRequired[DocumentAttributeTypeDef], # (1)
greaterThan: NotRequired[DocumentAttributeTypeDef], # (1)
greaterThanOrEquals: NotRequired[DocumentAttributeTypeDef], # (1)
lessThan: NotRequired[DocumentAttributeTypeDef], # (1)
lessThanOrEquals: NotRequired[DocumentAttributeTypeDef], # (1)
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
- See DocumentAttributeTypeDef
PredictQAppOutputTypeDef#
# PredictQAppOutputTypeDef definition
class PredictQAppOutputTypeDef(TypedDict):
app: PredictAppDefinitionTypeDef, # (1)
problemStatement: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)