Qapps Classes

AppDefinitionInputOutputTypeDef

cards

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.CardInputTypeDef]
• Required: Yes

initialPrompt

• Type: typing.Optional[str]

AppDefinitionInputTypeDef

cards

• Type: typing.Sequence[aws_resource_validator.pydantic_models.qapps_classes.CardInputTypeDef]
• Required: Yes

initialPrompt

• Type: typing.Optional[str]

AppDefinitionTypeDef

appDefinitionVersion

• Type:
• Required: Yes

cards

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.CardTypeDef]
• Required: Yes

canEdit

• Type: typing.Optional[bool]

AssociateLibraryItemReviewInputRequestTypeDef

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

AssociateQAppWithUserInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

AttributeFilterOutputTypeDef

andAllFilters

• Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

orAllFilters

• Type: typing.Optional[typing.List[typing.Dict[str, typing.Any]]]

notFilter

• Type: typing.Optional[typing.Dict[str, typing.Any]]

equalsTo

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

containsAll

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

containsAny

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

greaterThan

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

greaterThanOrEquals

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

lessThan

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

lessThanOrEquals

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.DocumentAttributeOutputTypeDef]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

CardInputTypeDef

textInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.TextInputCardInputTypeDef]

qQuery

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.QQueryCardInputTypeDef]

qPlugin

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.QPluginCardInputTypeDef]

fileUpload

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.FileUploadCardInputTypeDef]

CardStatusTypeDef

currentState

• Type: typing.Literal['COMPLETED', 'IN_PROGRESS', 'WAITING']
• Required: Yes

currentValue

• Type:
• Required: Yes

CardTypeDef

textInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.TextInputCardTypeDef]

qQuery

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.QQueryCardTypeDef]

qPlugin

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.QPluginCardTypeDef]

fileUpload

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.FileUploadCardTypeDef]

CardValueTypeDef

cardId

• Type:
• Required: Yes

value

• Type:
• Required: Yes

CategoryTypeDef

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

ConversationMessageTypeDef

body

• Type:
• Required: Yes

type

• Type: typing.Literal['SYSTEM', 'USER']
• Required: Yes

CreateLibraryItemInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.Sequence[str]
• Required: Yes

CreateLibraryItemOutputTypeDef

libraryItemId

• Type:
• Required: Yes

status

• Type:
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

updatedBy

• Type:
• Required: Yes

ratingCount

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateQAppInputRequestTypeDef

instanceId

• Type:
• Required: Yes

title

• Type:
• Required: Yes

appDefinition

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

tags

• Type: typing.Optional[typing.Mapping[str, str]]

CreateQAppOutputTypeDef

appId

• Type:
• Required: Yes

appArn

• Type:
• Required: Yes

title

• Type:
• Required: Yes

description

• Type:
• Required: Yes

initialPrompt

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

status

• Type: typing.Literal['DELETED', 'DRAFT', 'PUBLISHED']
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

updatedBy

• Type:
• Required: Yes

requiredCapabilities

• Type: typing.List[typing.Literal['CreatorMode', 'FileUpload', 'PluginMode', 'RetrievalMode']]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

DeleteLibraryItemInputRequestTypeDef

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

DeleteQAppInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

DisassociateLibraryItemReviewInputRequestTypeDef

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

DisassociateQAppFromUserInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

DocumentAttributeOutputTypeDef

name

• Type:
• Required: Yes

value

• Type:
• Required: Yes

DocumentAttributeValueOutputTypeDef

stringValue

• Type: typing.Optional[str]

stringListValue

• Type: typing.Optional[typing.List[str]]

longValue

• Type: typing.Optional[int]

dateValue

• Type: typing.Optional[datetime.datetime]

EmptyResponseMetadataTypeDef

ResponseMetadata

• Type:
• Required: Yes

FileUploadCardInputTypeDef

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

filename

• Type: typing.Optional[str]

fileId

• Type: typing.Optional[str]

allowOverride

• Type: typing.Optional[bool]

FileUploadCardTypeDef

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

• Type: typing.List[str]
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

filename

• Type: typing.Optional[str]

fileId

• Type: typing.Optional[str]

allowOverride

• Type: typing.Optional[bool]

GetLibraryItemInputRequestTypeDef

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

appId

• Type: typing.Optional[str]

GetLibraryItemOutputTypeDef

libraryItemId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.CategoryTypeDef]
• Required: Yes

status

• Type:
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

updatedBy

• Type:
• Required: Yes

ratingCount

• Type:
• Required: Yes

isRatedByUser

• Type:
• Required: Yes

userCount

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetQAppInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

GetQAppOutputTypeDef

appId

• Type:
• Required: Yes

appArn

• Type:
• Required: Yes

title

• Type:
• Required: Yes

description

• Type:
• Required: Yes

initialPrompt

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

status

• Type: typing.Literal['DELETED', 'DRAFT', 'PUBLISHED']
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

updatedBy

• Type:
• Required: Yes

requiredCapabilities

• Type: typing.List[typing.Literal['CreatorMode', 'FileUpload', 'PluginMode', 'RetrievalMode']]
• Required: Yes

appDefinition

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetQAppSessionInputRequestTypeDef

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

GetQAppSessionOutputTypeDef

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

status

• Type: typing.Literal['COMPLETED', 'IN_PROGRESS', 'WAITING']
• Required: Yes

cardStatus

• Type: typing.Dict[str, aws_resource_validator.pydantic_models.qapps_classes.CardStatusTypeDef]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ImportDocumentInputRequestTypeDef

instanceId

• Type:
• Required: Yes

cardId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

fileContentsBase64

• Type:
• Required: Yes

fileName

• Type:
• Required: Yes

scope

• Type: typing.Literal['APPLICATION', 'SESSION']
• Required: Yes

sessionId

• Type: typing.Optional[str]

ImportDocumentOutputTypeDef

fileId

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

LibraryItemMemberTypeDef

libraryItemId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.CategoryTypeDef]
• Required: Yes

status

• Type:
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

ratingCount

• Type:
• Required: Yes

updatedAt

• Type: typing.Optional[datetime.datetime]

updatedBy

• Type: typing.Optional[str]

isRatedByUser

• Type: typing.Optional[bool]

userCount

• Type: typing.Optional[int]

ListLibraryItemsInputListLibraryItemsPaginateTypeDef

instanceId

• Type:
• Required: Yes

categoryId

• Type: typing.Optional[str]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.PaginatorConfigTypeDef]

ListLibraryItemsInputRequestTypeDef

instanceId

• Type:
• Required: Yes

limit

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

categoryId

• Type: typing.Optional[str]

ListLibraryItemsOutputTypeDef

libraryItems

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.LibraryItemMemberTypeDef]
• Required: Yes

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListQAppsInputListQAppsPaginateTypeDef

instanceId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.PaginatorConfigTypeDef]

ListQAppsInputRequestTypeDef

instanceId

• Type:
• Required: Yes

limit

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

ListQAppsOutputTypeDef

apps

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.UserAppItemTypeDef]
• Required: Yes

nextToken

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceARN

• Type:
• Required: Yes

ListTagsForResourceResponseTypeDef

tags

• Type: typing.Dict[str, str]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

PaginatorConfigTypeDef

MaxItems

• Type: typing.Optional[int]

PageSize

• Type: typing.Optional[int]

StartingToken

• Type: typing.Optional[str]

PredictAppDefinitionTypeDef

title

• Type:
• Required: Yes

appDefinition

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

PredictQAppInputOptionsTypeDef

conversation

• Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.qapps_classes.ConversationMessageTypeDef]]

problemStatement

• Type: typing.Optional[str]

PredictQAppInputRequestTypeDef

instanceId

• Type:
• Required: Yes

options

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.PredictQAppInputOptionsTypeDef]

PredictQAppOutputTypeDef

app

• Type:
• Required: Yes

problemStatement

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

QPluginCardInputTypeDef

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

prompt

• Type:
• Required: Yes

pluginId

• Type:
• Required: Yes

QPluginCardTypeDef

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

• Type: typing.List[str]
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

prompt

• Type:
• Required: Yes

pluginType

• Type: typing.Literal['CUSTOM', 'JIRA', 'SALESFORCE', 'SERVICE_NOW', 'ZENDESK']
• Required: Yes

pluginId

• Type:
• Required: Yes

QQueryCardInputTypeDef

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

prompt

• Type:
• Required: Yes

outputSource

• Type: typing.Optional[typing.Literal['approved-sources', 'llm']]

attributeFilter

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.AttributeFilterOutputTypeDef]

QQueryCardTypeDef

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

• Type: typing.List[str]
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

prompt

• Type:
• Required: Yes

outputSource

• Type: typing.Literal['approved-sources', 'llm']
• Required: Yes

attributeFilter

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.AttributeFilterOutputTypeDef]

ResponseMetadataTypeDef

RequestId

• Type:
• Required: Yes

HTTPStatusCode

• Type:
• Required: Yes

HTTPHeaders

• Type: typing.Dict[str, str]
• Required: Yes

RetryAttempts

• Type:
• Required: Yes

HostId

• Type: typing.Optional[str]

StartQAppSessionInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

initialValues

• Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.qapps_classes.CardValueTypeDef]]

tags

• Type: typing.Optional[typing.Mapping[str, str]]

StartQAppSessionOutputTypeDef

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

StopQAppSessionInputRequestTypeDef

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

TagResourceRequestRequestTypeDef

resourceARN

• Type:
• Required: Yes

tags

• Type: typing.Mapping[str, str]
• Required: Yes

TextInputCardInputTypeDef

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

placeholder

• Type: typing.Optional[str]

defaultValue

• Type: typing.Optional[str]

TextInputCardTypeDef

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

• Type: typing.List[str]
• Required: Yes

type

• Type: typing.Literal['file-upload', 'q-plugin', 'q-query', 'text-input']
• Required: Yes

placeholder

• Type: typing.Optional[str]

defaultValue

• Type: typing.Optional[str]

UntagResourceRequestRequestTypeDef

resourceARN

• Type:
• Required: Yes

tagKeys

• Type: typing.Sequence[str]
• Required: Yes

UpdateLibraryItemInputRequestTypeDef

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

status

• Type: typing.Optional[typing.Literal['DISABLED', 'PUBLISHED']]

categories

• Type: typing.Optional[typing.Sequence[str]]

UpdateLibraryItemOutputTypeDef

libraryItemId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.List[aws_resource_validator.pydantic_models.qapps_classes.CategoryTypeDef]
• Required: Yes

status

• Type:
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

updatedBy

• Type:
• Required: Yes

ratingCount

• Type:
• Required: Yes

isRatedByUser

• Type:
• Required: Yes

userCount

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateQAppInputRequestTypeDef

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

title

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

appDefinition

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps_classes.AppDefinitionInputTypeDef]

UpdateQAppOutputTypeDef

appId

• Type:
• Required: Yes

appArn

• Type:
• Required: Yes

title

• Type:
• Required: Yes

description

• Type:
• Required: Yes

initialPrompt

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

status

• Type: typing.Literal['DELETED', 'DRAFT', 'PUBLISHED']
• Required: Yes

createdAt

• Type:
• Required: Yes

createdBy

• Type:
• Required: Yes

updatedAt

• Type:
• Required: Yes

updatedBy

• Type:
• Required: Yes

requiredCapabilities

• Type: typing.List[typing.Literal['CreatorMode', 'FileUpload', 'PluginMode', 'RetrievalMode']]
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateQAppSessionInputRequestTypeDef

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

values

• Type: typing.Optional[typing.Sequence[aws_resource_validator.pydantic_models.qapps_classes.CardValueTypeDef]]

UpdateQAppSessionOutputTypeDef

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UserAppItemTypeDef

appId

• Type:
• Required: Yes

appArn

• Type:
• Required: Yes

title

• Type:
• Required: Yes

createdAt

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

canEdit

• Type: typing.Optional[bool]

status

• Type: typing.Optional[str]