String appDefinitionVersion
The version of the app definition schema or specification.
List<E> cards
The cards that make up the Q App, such as text input, file upload, or query cards.
Boolean canEdit
A flag indicating whether the Q App's definition can be edited by the user.
List<E> andAllFilters
Performs a logical AND operation on all supplied filters.
List<E> orAllFilters
Performs a logical OR operation on all supplied filters.
AttributeFilter notFilter
Performs a logical NOT operation on all supplied filters.
DocumentAttribute equalsTo
Performs an equals operation on two document attributes or metadata fields. Supported for the following document
attribute value types: dateValue, longValue, stringListValue and
stringValue.
DocumentAttribute containsAll
Returns true when a document contains all the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue.
DocumentAttribute containsAny
Returns true when a document contains any of the specified document attributes or metadata fields.
Supported for the following document
attribute value types: stringListValue.
DocumentAttribute greaterThan
Performs a greater than operation on two document attributes or metadata fields. Supported for the
following document
attribute value types: dateValue and longValue.
DocumentAttribute greaterThanOrEquals
Performs a greater than or equals operation on two document attributes or metadata fields. Supported for
the following document
attribute value types: dateValue and longValue.
DocumentAttribute lessThan
Performs a less than operation on two document attributes or metadata fields. Supported for the following
document
attribute value types: dateValue and longValue.
DocumentAttribute lessThanOrEquals
Performs a less than or equals operation on two document attributes or metadata fields.Supported for the
following document
attribute value type: dateValue and longValue.
TextInputCard textInput
A container for the properties of the text input card.
QQueryCard qQuery
A container for the properties of the query card.
QPluginCard qPlugin
A container for the properties of the plugin card.
FileUploadCard fileUpload
A container for the properties of the file upload card.
TextInputCardInput textInput
A container for the properties of the text input card.
QQueryCardInput qQuery
A container for the properties of the query input card.
QPluginCardInput qPlugin
A container for the properties of the plugin input card.
FileUploadCardInput fileUpload
A container for the properties of the file upload input card.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
String appId
The unique identifier of the Amazon Q App to publish to the library.
Integer appVersion
The version of the Amazon Q App to publish to the library.
List<E> categories
The categories to associate with the library item for easier discovery.
String libraryItemId
The unique identifier of the new library item.
String status
The status of the new library item, such as "Published".
Date createdAt
The date and time the library item was created.
String createdBy
The user who created the library item.
Date updatedAt
The date and time the library item was last updated.
String updatedBy
The user who last updated the library item.
Integer ratingCount
The number of ratings the library item has received from users.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
String title
The title of the new Q App.
String description
The description of the new Q App.
AppDefinitionInput appDefinition
The definition of the new Q App, specifying the cards and flow.
Map<K,V> tags
Optional tags to associate with the new Q App.
String appId
The unique identifier of the new Q App.
String appArn
The Amazon Resource Name (ARN) of the new Q App.
String title
The title of the new Q App.
String description
The description of the new Q App.
String initialPrompt
The initial prompt displayed when the Q App is started.
Integer appVersion
The version of the new Q App.
String status
The status of the new Q App, such as "Created".
Date createdAt
The date and time the Q App was created.
String createdBy
The user who created the Q App.
Date updatedAt
The date and time the Q App was last updated.
String updatedBy
The user who last updated the Q App.
List<E> requiredCapabilities
The capabilities required to run the Q App, such as file upload or third-party integrations.
String name
The identifier for the attribute.
DocumentAttributeValue value
The value of the attribute.
String stringValue
A string.
List<E> stringListValue
A list of strings.
Long longValue
A long integer value.
Date dateValue
A date expressed as an ISO 8601 string.
It's important for the time zone to be included in the ISO 8601 date-time format. For example, 2012-03-25T12:30:10+01:00 is the ISO 8601 date-time format for March 25th 2012 at 12:30PM (plus 10 seconds) in Central European Time.
String id
The unique identifier of the file upload card.
String title
The title of the file upload card.
List<E> dependencies
Any dependencies or requirements for the file upload card.
String type
The type of the card.
String filename
The name of the file being uploaded.
String fileId
The unique identifier of the file associated with the card.
Boolean allowOverride
A flag indicating if the user can override the default file for the upload card.
String title
The title or label of the file upload card.
String id
The unique identifier of the file upload card.
String type
The type of the card.
String filename
The default filename to use for the file upload card.
String fileId
The identifier of a pre-uploaded file associated with the card.
Boolean allowOverride
A flag indicating if the user can override the default file for the upload card.
String libraryItemId
The unique identifier of the library item.
String appId
The unique identifier of the Q App associated with the library item.
Integer appVersion
The version of the Q App associated with the library item.
List<E> categories
The categories associated with the library item for discovery.
String status
The status of the library item, such as "Published".
Date createdAt
The date and time the library item was created.
String createdBy
The user who created the library item.
Date updatedAt
The date and time the library item was last updated.
String updatedBy
The user who last updated the library item.
Integer ratingCount
The number of ratings the library item has received from users.
Boolean isRatedByUser
Whether the current user has rated the library item.
Integer userCount
The number of users who have associated the Q App with their account.
String appId
The unique identifier of the Q App.
String appArn
The Amazon Resource Name (ARN) of the Q App.
String title
The title of the Q App.
String description
The description of the Q App.
String initialPrompt
The initial prompt displayed when the Q App is started.
Integer appVersion
The version of the Q App.
String status
The status of the Q App.
Date createdAt
The date and time the Q App was created.
String createdBy
The user who created the Q App.
Date updatedAt
The date and time the Q App was last updated.
String updatedBy
The user who last updated the Q App.
List<E> requiredCapabilities
The capabilities required to run the Q App, such as file upload or third-party integrations.
AppDefinition appDefinition
The full definition of the Q App, specifying the cards and flow.
String sessionId
The unique identifier of the Q App session.
String sessionArn
The Amazon Resource Name (ARN) of the Q App session.
String status
The current status of the Q App session.
Map<K,V> cardStatus
The current status for each card in the Q App session.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
String cardId
The unique identifier of the card the file is associated with, if applicable.
String appId
The unique identifier of the Q App the file is associated with.
String fileContentsBase64
The base64-encoded contents of the file to upload.
String fileName
The name of the file being uploaded.
String scope
Whether the file is associated with an Q App definition or a specific Q App session.
String sessionId
The unique identifier of the Q App session the file is associated with, if applicable.
String fileId
The unique identifier assigned to the uploaded file.
Integer retryAfterSeconds
The number of seconds to wait before retrying the operation
String libraryItemId
The unique identifier of the library item.
String appId
The unique identifier of the Q App associated with the library item.
Integer appVersion
The version of the Q App associated with the library item.
List<E> categories
The categories associated with the library item.
String status
The status of the library item.
Date createdAt
The date and time the library item was created.
String createdBy
The user who created the library item.
Date updatedAt
The date and time the library item was last updated.
String updatedBy
The user who last updated the library item.
Integer ratingCount
The number of ratings the library item has received.
Boolean isRatedByUser
Whether the current user has rated the library item.
Integer userCount
The number of users who have the associated Q App.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
Integer limit
The maximum number of library items to return in the response.
String nextToken
The token to request the next page of results.
String categoryId
Optional category to filter the library items by.
String resourceARN
The Amazon Resource Name (ARN) of the resource whose tags should be listed.
String title
The title of the generated Q App definition.
String description
The description of the generated Q App definition.
AppDefinitionInput appDefinition
The definition specifying the cards and flow of the generated Q App.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
PredictQAppInputOptions options
The input to generate the Q App definition from, either a conversation or problem statement.
PredictAppDefinition app
The generated Q App definition.
String problemStatement
The problem statement extracted from the input conversation, if provided.
String id
The unique identifier of the plugin card.
String title
The title or label of the plugin card.
List<E> dependencies
Any dependencies or requirements for the plugin card.
String type
The type of the card.
String prompt
The prompt or instructions displayed for the plugin card.
String pluginType
The type or category of the plugin used by the card.
String pluginId
The unique identifier of the plugin used by the card.
String title
The title or label of the plugin card.
String id
The unique identifier of the plugin card.
String type
The type of the card.
String prompt
The prompt or instructions displayed for the plugin card.
String pluginId
The unique identifier of the plugin used by the card.
String id
The unique identifier of the query card.
String title
The title or label of the query card.
List<E> dependencies
Any dependencies or requirements for the query card.
String type
The type of the card.
String prompt
The prompt or instructions displayed for the query card.
String outputSource
The source or type of output generated by the query card.
AttributeFilter attributeFilter
The Amazon Q Business filters applied in this query card when resolving data sources
String title
The title or label of the query card.
String id
The unique identifier of the query card.
String type
The type of the card.
String prompt
The prompt or instructions displayed for the query card.
String outputSource
The source or type of output to generate for the query card.
AttributeFilter attributeFilter
Turns on filtering of responses based on document attributes or metadata fields.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
String appId
The unique identifier of the Q App to start a session for.
Integer appVersion
The version of the Q App to use for the session.
List<E> initialValues
Optional initial input values to provide for the Q App session.
Map<K,V> tags
Optional tags to associate with the new Q App session.
String id
The unique identifier of the text input card.
String title
The title or label of the text input card.
List<E> dependencies
Any dependencies or requirements for the text input card.
String type
The type of the card.
String placeholder
The placeholder text to display in the text input field.
String defaultValue
The default value to pre-populate in the text input field.
String title
The title or label of the text input card.
String id
The unique identifier of the text input card.
String type
The type of the card.
String placeholder
The placeholder text to display in the text input field.
String defaultValue
The default value to pre-populate in the text input field.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
String libraryItemId
The unique identifier of the library item to update.
String status
The new status to set for the library item, such as "Published" or "Hidden".
List<E> categories
The new categories to associate with the library item.
String libraryItemId
The unique identifier of the updated library item.
String appId
The unique identifier of the Q App associated with the library item.
Integer appVersion
The version of the Q App associated with the library item.
List<E> categories
The categories associated with the updated library item.
String status
The new status of the updated library item.
Date createdAt
The date and time the library item was originally created.
String createdBy
The user who originally created the library item.
Date updatedAt
The date and time the library item was last updated.
String updatedBy
The user who last updated the library item.
Integer ratingCount
The number of ratings the library item has received.
Boolean isRatedByUser
Whether the current user has rated the library item.
Integer userCount
The number of users who have the associated Q App.
String instanceId
The unique identifier of the Amazon Q Business application environment instance.
String appId
The unique identifier of the Q App to update.
String title
The new title for the Q App.
String description
The new description for the Q App.
AppDefinitionInput appDefinition
The new definition specifying the cards and flow for the Q App.
String appId
The unique identifier of the updated Q App.
String appArn
The Amazon Resource Name (ARN) of the updated Q App.
String title
The new title of the updated Q App.
String description
The new description of the updated Q App.
String initialPrompt
The initial prompt for the updated Q App.
Integer appVersion
The new version of the updated Q App.
String status
The status of the updated Q App.
Date createdAt
The date and time the Q App was originally created.
String createdBy
The user who originally created the Q App.
Date updatedAt
The date and time the Q App was last updated.
String updatedBy
The user who last updated the Q App.
List<E> requiredCapabilities
The capabilities required for the updated Q App.
String appId
The unique identifier of the Q App.
String appArn
The Amazon Resource Name (ARN) of the Q App.
String title
The title of the Q App.
String description
The description of the Q App.
Date createdAt
The date and time the user's association with the Q App was created.
Boolean canEdit
A flag indicating whether the user can edit the Q App.
String status
The status of the user's association with the Q App.
Copyright © 2025. All rights reserved.