Qapps Classes

AppDefinition

appDefinitionVersion

• Type:
• Required: Yes

cards

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

canEdit

• Type: typing.Optional[bool]

AppDefinitionInput

cards

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

initialPrompt

• Type: typing.Optional[str]

AppDefinitionInputOutput

cards

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

initialPrompt

• Type: typing.Optional[str]

AssociateLibraryItemReviewInput

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

AssociateQAppWithUserInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

AttributeFilter

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.qapps_classes.DocumentAttribute]

containsAll

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttribute]

containsAny

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttribute]

greaterThan

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttribute]

greaterThanOrEquals

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttribute]

lessThan

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttribute]

lessThanOrEquals

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttribute]

AttributeFilterOutput

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.qapps_classes.DocumentAttributeOutput]

containsAll

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttributeOutput]

containsAny

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttributeOutput]

greaterThan

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttributeOutput]

greaterThanOrEquals

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttributeOutput]

lessThan

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttributeOutput]

lessThanOrEquals

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.DocumentAttributeOutput]

BaseValidatorModel

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

BatchCreateCategoryInput

instanceId

• Type:
• Required: Yes

categories

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

BatchCreateCategoryInputCategory

title

• Type:
• Required: Yes

id

• Type: typing.Optional[str]

color

• Type: typing.Optional[str]

BatchDeleteCategoryInput

instanceId

• Type:
• Required: Yes

categories

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

BatchUpdateCategoryInput

instanceId

• Type:
• Required: Yes

categories

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

Card

textInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.TextInputCard]

qQuery

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.QQueryCard]

qPlugin

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.QPluginCard]

fileUpload

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.FileUploadCard]

formInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.FormInputCard]

CardInput

textInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.TextInputCardInput]

qQuery

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.QQueryCardInput]

qPlugin

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.QPluginCardInput]

fileUpload

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.FileUploadCardInput]

formInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.FormInputCardInput]

CardInputOutput

textInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.TextInputCardInput]

qQuery

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.QQueryCardInputOutput]

qPlugin

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.QPluginCardInput]

fileUpload

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.FileUploadCardInput]

formInput

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.FormInputCardInputOutput]

CardStatus

currentState

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

currentValue

• Type:
• Required: Yes

submissions

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.Submission]]

CardValue

cardId

• Type:
• Required: Yes

value

• Type:
• Required: Yes

submissionMutation

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.SubmissionMutation]

Category

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

color

• Type: typing.Optional[str]

appCount

• Type: typing.Optional[int]

CategoryInput

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

color

• Type: typing.Optional[str]

ConversationMessage

body

• Type:
• Required: Yes

type

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

CreateLibraryItemInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

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

CreateLibraryItemOutput

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

isVerified

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreatePresignedUrlInput

instanceId

• Type:
• Required: Yes

cardId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

fileContentsSha256

• Type:
• Required: Yes

fileName

• Type:
• Required: Yes

scope

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

sessionId

• Type: typing.Optional[str]

CreatePresignedUrlOutput

fileId

• Type:
• Required: Yes

presignedUrl

• Type:
• Required: Yes

presignedUrlFields

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

presignedUrlExpiration

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

CreateQAppInput

instanceId

• Type:
• Required: Yes

title

• Type:
• Required: Yes

appDefinition

• Type: typing.Union[aws_resource_validator.pydantic_models.qapps.qapps_classes.AppDefinitionInput, aws_resource_validator.pydantic_models.qapps.qapps_classes.AppDefinitionInputOutput]
• Required: Yes

description

• Type: typing.Optional[str]

tags

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

CreateQAppOutput

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

DeleteLibraryItemInput

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

DeleteQAppInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

DescribeQAppPermissionsInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

DescribeQAppPermissionsOutput

resourceArn

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

permissions

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

ResponseMetadata

• Type:
• Required: Yes

DisassociateLibraryItemReviewInput

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

DisassociateQAppFromUserInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

DocumentAttribute

name

• Type:
• Required: Yes

value

• Type:
• Required: Yes

DocumentAttributeOutput

name

• Type:
• Required: Yes

value

• Type:
• Required: Yes

DocumentAttributeValue

stringValue

• Type: typing.Optional[str]

stringListValue

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

longValue

• Type: typing.Optional[int]

dateValue

• Type: typing.Union[datetime.datetime, str, NoneType]

DocumentAttributeValueOutput

stringValue

• Type: typing.Optional[str]

stringListValue

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

longValue

• Type: typing.Optional[int]

dateValue

• Type: typing.Optional[datetime.datetime]

EmptyResponseMetadata

ResponseMetadata

• Type:
• Required: Yes

ExportQAppSessionDataInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

ExportQAppSessionDataOutput

csvFileLink

• Type:
• Required: Yes

expiresAt

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

FileUploadCard

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

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

type

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

filename

• Type: typing.Optional[str]

fileId

• Type: typing.Optional[str]

allowOverride

• Type: typing.Optional[bool]

FileUploadCardInput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

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

filename

• Type: typing.Optional[str]

fileId

• Type: typing.Optional[str]

allowOverride

• Type: typing.Optional[bool]

FormInputCard

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

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

type

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

metadata

• Type:
• Required: Yes

computeMode

• Type: typing.Optional[typing.Literal['append', 'replace']]

FormInputCardInput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

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

metadata

• Type:
• Required: Yes

computeMode

• Type: typing.Optional[typing.Literal['append', 'replace']]

FormInputCardInputOutput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

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

metadata

• Type:
• Required: Yes

computeMode

• Type: typing.Optional[typing.Literal['append', 'replace']]

FormInputCardMetadata

schema

• Type: typing.Dict[str, typing.Any]
• Default: >

FormInputCardMetadataOutput

schema

• Type: typing.Dict[str, typing.Any]
• Default: >

GetLibraryItemInput

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

appId

• Type: typing.Optional[str]

GetLibraryItemOutput

libraryItemId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.Category]
• 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

isVerified

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetQAppInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type: typing.Optional[int]

GetQAppOutput

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

GetQAppSessionInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

GetQAppSessionMetadataInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

GetQAppSessionMetadataOutput

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

sessionName

• Type:
• Required: Yes

sharingConfiguration

• Type:
• Required: Yes

sessionOwner

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

GetQAppSessionOutput

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

sessionName

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

latestPublishedAppVersion

• Type:
• Required: Yes

status

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

cardStatus

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

userIsHost

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

ImportDocumentInput

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]

ImportDocumentOutput

fileId

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

LibraryItemMember

libraryItemId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.Category]
• 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]

isVerified

• Type: typing.Optional[bool]

ListCategoriesInput

instanceId

• Type:
• Required: Yes

ListCategoriesOutput

categories

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

ResponseMetadata

• Type:
• Required: Yes

ListLibraryItemsInput

instanceId

• Type:
• Required: Yes

limit

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

categoryId

• Type: typing.Optional[str]

ListLibraryItemsInputPaginate

instanceId

• Type:
• Required: Yes

categoryId

• Type: typing.Optional[str]

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.PaginatorConfig]

ListLibraryItemsOutput

libraryItems

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

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListQAppSessionDataInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

ListQAppSessionDataOutput

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

sessionData

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

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListQAppsInput

instanceId

• Type:
• Required: Yes

limit

• Type: typing.Optional[int]

nextToken

• Type: typing.Optional[str]

ListQAppsInputPaginate

instanceId

• Type:
• Required: Yes

PaginationConfig

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.PaginatorConfig]

ListQAppsOutput

apps

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

ResponseMetadata

• Type:
• Required: Yes

nextToken

• Type: typing.Optional[str]

ListTagsForResourceRequest

resourceARN

• Type:
• Required: Yes

ListTagsForResourceResponse

tags

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

ResponseMetadata

• Type:
• Required: Yes

PaginatorConfig

MaxItems

• Type: typing.Optional[int]

PageSize

• Type: typing.Optional[int]

StartingToken

• Type: typing.Optional[str]

PermissionInput

action

• Type: typing.Literal['read', 'write']
• Required: Yes

principal

• Type:
• Required: Yes

PermissionOutput

action

• Type: typing.Literal['read', 'write']
• Required: Yes

principal

• Type:
• Required: Yes

PredictAppDefinition

title

• Type:
• Required: Yes

appDefinition

• Type:
• Required: Yes

description

• Type: typing.Optional[str]

PredictQAppInput

instanceId

• Type:
• Required: Yes

options

• Type: typing.Optional[aws_resource_validator.pydantic_models.qapps.qapps_classes.PredictQAppInputOptions]

PredictQAppInputOptions

conversation

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.ConversationMessage]]

problemStatement

• Type: typing.Optional[str]

PredictQAppOutput

app

• Type:
• Required: Yes

problemStatement

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

PrincipalOutput

userId

• Type: typing.Optional[str]

userType

• Type: typing.Optional[typing.Literal['owner', 'user']]

email

• Type: typing.Optional[str]

QAppSessionData

cardId

• Type:
• Required: Yes

user

• Type:
• Required: Yes

value

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

submissionId

• Type: typing.Optional[str]

timestamp

• Type: typing.Optional[datetime.datetime]

QPluginCard

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

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

type

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

prompt

• Type:
• Required: Yes

pluginType

• Type: typing.Literal['ASANA', 'ATLASSIAN_CONFLUENCE', 'CUSTOM', 'GOOGLE_CALENDAR', 'JIRA', 'JIRA_CLOUD', 'MICROSOFT_EXCHANGE', 'MICROSOFT_TEAMS', 'PAGERDUTY_ADVANCE', 'SALESFORCE', 'SALESFORCE_CRM', 'SERVICENOW_NOW_PLATFORM', 'SERVICE_NOW', 'SMARTSHEET', 'ZENDESK', 'ZENDESK_SUITE']
• Required: Yes

pluginId

• Type:
• Required: Yes

actionIdentifier

• Type: typing.Optional[str]

QPluginCardInput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

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

prompt

• Type:
• Required: Yes

pluginId

• Type:
• Required: Yes

actionIdentifier

• Type: typing.Optional[str]

QQueryCard

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

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

type

• Type: typing.Literal['file-upload', 'form-input', '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.qapps_classes.AttributeFilterOutput]

memoryReferences

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

QQueryCardInput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

• Type: typing.Literal['file-upload', 'form-input', '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.qapps_classes.AttributeFilter]

QQueryCardInputOutput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

• Type: typing.Literal['file-upload', 'form-input', '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.qapps_classes.AttributeFilterOutput]

ResponseMetadata

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]

SessionSharingConfiguration

enabled

• Type:
• Required: Yes

acceptResponses

• Type: typing.Optional[bool]

revealCards

• Type: typing.Optional[bool]

StartQAppSessionInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

initialValues

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.CardValue]]

sessionId

• Type: typing.Optional[str]

tags

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

StartQAppSessionOutput

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

StopQAppSessionInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

Submission

value

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

submissionId

• Type: typing.Optional[str]

timestamp

• Type: typing.Optional[datetime.datetime]

SubmissionMutation

submissionId

• Type:
• Required: Yes

mutationType

• Type: typing.Literal['add', 'delete', 'edit']
• Required: Yes

TagResourceRequest

resourceARN

• Type:
• Required: Yes

tags

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

TextInputCard

id

• Type:
• Required: Yes

title

• Type:
• Required: Yes

dependencies

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

type

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

placeholder

• Type: typing.Optional[str]

defaultValue

• Type: typing.Optional[str]

TextInputCardInput

title

• Type:
• Required: Yes

id

• Type:
• Required: Yes

type

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

placeholder

• Type: typing.Optional[str]

defaultValue

• Type: typing.Optional[str]

UntagResourceRequest

resourceARN

• Type:
• Required: Yes

tagKeys

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

UpdateLibraryItemInput

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

status

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

categories

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

UpdateLibraryItemMetadataInput

instanceId

• Type:
• Required: Yes

libraryItemId

• Type:
• Required: Yes

isVerified

• Type: typing.Optional[bool]

UpdateLibraryItemOutput

libraryItemId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

appVersion

• Type:
• Required: Yes

categories

• Type: typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.Category]
• 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

isVerified

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateQAppInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

title

• Type: typing.Optional[str]

description

• Type: typing.Optional[str]

appDefinition

• Type: typing.Union[aws_resource_validator.pydantic_models.qapps.qapps_classes.AppDefinitionInput, aws_resource_validator.pydantic_models.qapps.qapps_classes.AppDefinitionInputOutput, NoneType]

UpdateQAppOutput

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

UpdateQAppPermissionsInput

instanceId

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

grantPermissions

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.PermissionInput]]

revokePermissions

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.PermissionInput]]

UpdateQAppPermissionsOutput

resourceArn

• Type:
• Required: Yes

appId

• Type:
• Required: Yes

permissions

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

ResponseMetadata

• Type:
• Required: Yes

UpdateQAppSessionInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

values

• Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.qapps.qapps_classes.CardValue]]

UpdateQAppSessionMetadataInput

instanceId

• Type:
• Required: Yes

sessionId

• Type:
• Required: Yes

sharingConfiguration

• Type:
• Required: Yes

sessionName

• Type: typing.Optional[str]

UpdateQAppSessionMetadataOutput

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

sessionName

• Type:
• Required: Yes

sharingConfiguration

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

UpdateQAppSessionOutput

sessionId

• Type:
• Required: Yes

sessionArn

• Type:
• Required: Yes

ResponseMetadata

• Type:
• Required: Yes

User

userId

• Type: typing.Optional[str]

UserAppItem

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]

isVerified

• Type: typing.Optional[bool]