Amazon Q Business - Supported Data Types

Amazon Q Business consists of list of data types that are associated with their specific functionality.

Q Business Supported Data Types

The following data types are supported by QBusiness:

• AccessConfiguration: Used to configure access permissions for a document.
• AccessControl: A list of principals, either a USER or a GROUP with ALLOW or DENY document access permissions.
• ActionExecution: used to perform an Amazon Q Business plugin action during a non-streaming chat conversation.
• ActionExecutionEvent: A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat.
• ActionExecutionPayloadField: is a user input field in an plugin action execution payload.
• ActionReview: Returns an output event containing information about the selected plugin action and a list of possible user input fields, some pre-populated by Amazon Q Business.
• ActionReviewEvent: output an event when you want to perform a plugin action during a streaming chat conversation.
• ActionReviewPayloadField: A user input field in an plugin action review payload.
• ActionReviewPayloadFieldAllowedValue: Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.
• APISchema: Contains details about the OpenAPI schema for a custom plugin.
• Application: Summary information for an Amazon Q Business application.
• AppliedAttachmentsConfiguration: used to configure information about the file upload during chat feature for your application.
• AppliedCreatorModeConfiguration: defines a creator mode specific admin controls configured for an Amazon Q Business application.
• AttachmentInput: Is a file directly uploaded into a web experience chat.
• AttachmentInputEvent: Is a file input event activated by a end user request to upload files into their web experience chat.
• AttachmentOutput: is the details of a file uploaded during chat.
• AttachmentsConfiguration: Is configuration information for the file upload during chat feature.
• AttributeFilter: Enables filtering of responses based on document attributes or metadata fields.
• AuthChallengeRequest: is a request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user.
• AuthChallengeRequestEvent: is an authentication verification event activated by an end user request to use a custom plugin.
• AuthChallengeResponse: Contains details of the authentication information received from a third party authentication server in response to an authentication challenge.
• AuthChallengeResponseEvent: An authentication verification event response by a third party authentication server to Amazon Q Business.
• AutoSubscriptionConfiguration: is a subscription configuration information for an Amazon Q Business application using IAM identity federation for user management.
• BasicAuthConfiguration: contains information about the basic authentication credentials used to configure a plugin.
• BlockedPhrasesConfiguration: Provides information about the phrases blocked from chat by your chat control configuration.
• BlockedPhrasesConfigurationUpdate: used to updates a blocked phrases configuration in your Amazon Q Business application.
• ChatInputStream: is the streaming input for the Chat API.
• ChatModeConfiguration: contains Configuration information for Amazon Q Business conversation modes.
• ChatOutputStream: is the streaming output for the Chat API.
• ConfigurationEvent: A configuration event activated by an end user request to select a specific chat mode.
• ContentBlockerRule: A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic.
• ContentRetrievalRule: Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration.
• Conversation: is a conversation in an Amazon Q Business application.
• CreatorModeConfiguration: contains Configuration information required to invoke chat in CREATOR_MODE.
• CustomPluginConfiguration: contains Configuration information required to create a custom plugin.
• DataSource: is a data source in an Amazon Q Business application.
• DataSourceSyncJob: Provides information about an Amazon Q Business data source connector synchronization job.
• DataSourceSyncJobMetrics: used to map a batch delete document request to a specific Amazon Q Business data source connector sync job.
• DataSourceVpcConfiguration: Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud).
• DateAttributeBoostingConfiguration: Provides information on boosting DATE type document attributes.
• DeleteDocument: is a document deleted from an Amazon Q Business data source connector.
• Document: is a document in an Amazon Q Business application.
• DocumentAttribute: is a document attribute or metadata field.
• DocumentAttributeBoostingConfiguration: Provides information on boosting supported Amazon Q Business document attribute types.
• DocumentAttributeCondition: is the condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business.
• DocumentAttributeConfiguration: contains Configuration information for document attributes.
• DocumentAttributeTarget: is the target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.
• DocumentAttributeValue: is the value of a document attribute. You can only provide one value for a document attribute.
• DocumentContent: is the contents of a document.
• DocumentDetails: is the details of a document within an Amazon Q Business index.
• DocumentEnrichmentConfiguration: Provides the configuration information for altering document metadata and content during the document ingestion process.
• EligibleDataSource: is the identifier of the data source Amazon Q Business will generate responses from.
• EncryptionConfiguration: Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business.
• EndOfInputEvent: is the end of the streaming input for the Chat API.
• ErrorDetail: Provides information about a data source sync error.
• FailedAttachmentEvent: is a failed file upload during web experience chat.
• FailedDocument: is a list of documents that could not be removed from an Amazon Q Business index.
• GroupMembers: is a list of users or sub groups that belong to a group.
• GroupStatusDetail: Provides the details of a group's status.
• GroupSummary: contain Summary information for groups.
• HookConfiguration: used to configure a Lambda function to change document metadata and content when adding documents to Amazon Q Business.
• IdentityProviderConfiguration: Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
• Index: contain summary information for your Amazon Q Business index.
• IndexCapacityConfiguration: Provides information about index capacity configuration.
• IndexStatistics: Provides information about the number of documents in an index.
• InlineDocumentEnrichmentConfiguration: Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business.
• KendraIndexConfiguration: used to stores an Amazon Kendra index as a retriever.
• MemberGroup: is the sub groups that belong to a group.
• MemberUser: is the users that belong to a group.
• Message: is a message in an Amazon Q Business web experience.
• MessageUsefulnessFeedback: is an end user feedback on an AI-generated web experience chat message usefulness.
• MetadataEvent: A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated.
• NativeIndexConfiguration: contain configuration information for an Amazon Q Business index.
• NoAuthConfiguration: contain information about invoking a custom plugin without any authentication or authorization requirement.
• NumberAttributeBoostingConfiguration: Provides information on boosting NUMBER type document attributes.
• OAuth2ClientCredentialConfiguration: contain information about the OAuth 2.0 authentication credential/token used to configure a plugin.
• OpenIDConnectProviderConfiguration: contain information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
• PersonalizationConfiguration: contain configuration information about chat response personalization.
• Plugin: contain information about an Amazon Q Business plugin and its configuration.
• PluginAuthConfiguration: contain authentication configuration information for an Amazon Q Business plugin.
• PluginConfiguration: contain configuration information required to invoke chat in PLUGIN_MODE.
• Principal: Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses.
• PrincipalGroup: Provides information about a group associated with the principal.
• PrincipalUser: Provides information about a user associated with a principal.
• QAppsConfiguration: contain configuration information about Amazon Q Apps. (preview feature)
• Retriever: contain summary information for the retriever used for your Amazon Q Business application.
• RetrieverConfiguration: Provides information on how the retriever used for your Amazon Q Business application is configured.
• Rule: Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.
• RuleConfiguration: Provides configuration information about a rule.
• S3: is a information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.
• SamlConfiguration: Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience.
• SamlProviderConfiguration: is information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience.
• SnippetExcerpt: Contains the relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.
• SourceAttribution: is the documents used to generate an Amazon Q Business web experience response.
• StringAttributeBoostingConfiguration: Provides information on boosting STRING type document attributes.
• StringListAttributeBoostingConfiguration: Provides information on boosting STRING_LIST type document attributes.
• Tag: is a list of key/value pairs that identify an index, FAQ, or data source.
• TextDocumentStatistics: Provides information about text documents in an index.
• TextInputEvent: An input event for a end user message in an Amazon Q Business web experience.
• TextOutputEvent: An output event for an AI-generated response in an Amazon Q Business web experience.
• TextSegment: Provides information about a text extract in a chat response that can be attributed to a source document.
• TopicConfiguration: The topic specific controls configured for an Amazon Q Business application.
• UserAlias: Aliases attached to a user id within an Amazon Q Business application.
• UsersAndGroups: Provides information about users and group names associated with a topic control rule.
• ValidationExceptionField: The input failed to meet the constraints specified by Amazon Q Business in a specified field.
• WebExperience: Provides information for an Amazon Q Business web experience.
• WebExperienceAuthConfiguration: Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users.

Q Apps Supported Data Types

The following data types are supported by QApps:

• AppDefinition: is the definition of the Q App, specifying the cards and flow.
• AppDefinitionInput: is the input for defining an Q App.
• AttributeFilter: is the filter criteria used on responses based on document attributes or metadata fields.
• Card: is a card representing a component or step in an Amazon Q App's flow.
• CardInput: is the properties defining an input card in an Amazon Q App.
• CardStatus: is the current status and value of a card in an active Amazon Q App session.
• CardValue: is the value or result associated with a card in a Amazon Q App session.
• Category: is a category used to classify and filter library items for Amazon Q Apps.
• ConversationMessage: is a message in a conversation, used as input for generating an Amazon Q App definition.
• DocumentAttribute: is a document attribute or metadata field.
• DocumentAttributeValue: is the value of a document attribute.
• FileUploadCard: is a card in an Amazon Q App that allows the user to upload a file.
• FileUploadCardInput: Represents a file upload card.
• LibraryItemMember: is a library item is a snapshot of an Amazon Q App that can be published so the users in their Amazon Q Apps library can discover it, clone it, and run it.
• PredictAppDefinition: is the definition of an Amazon Q App generated based on input such as a conversation or problem statement.
• PredictQAppInputOptions: is the input options for generating an Q App definition.
• QPluginCard: is a card in an Q App that integrates with a third-party plugin or service.
• QPluginCardInput: is the input shape for defining a plugin card in an Amazon Q App.
• QQueryCard: is a card in a Amazon Q App that generates a response based on the Amazon Q Business service.
• QQueryCardInput: is the input shape for defining a query card in an Amazon Q App.
• TextInputCard: is a card in an Amazon Q App that allows the user to input text.
• TextInputCardInput: is the input shape for defining a text input card in an Amazon Q App.
• UserAppItem: is an Amazon Q App associated with a user, either owned by the user or favorited.