# Amazon Q Business API Reference ## [QBusiness](https://docs.aws.amazon.com/amazonq/latest/api-reference/Welcome_QBusiness.md) This is the Amazon Q BusinessAPI Reference. Amazon Q Business is a fully managed, generative-AI powered enterprise chat assistant that you can deploy within your organization. Amazon Q Business enhances employee productivity by supporting key tasks such as question-answering, knowledge discovery, writing email messages, summarizing text, drafting document outlines, and brainstorming ideas. Users ask questions of Amazon Q Business and get answers that are presented in a conversational manner. For an introduction to the service, see the [Amazon Q Business User Guide](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/what-is.html). For an overview of the Amazon Q Business APIs, see [Overview of Amazon Q Business API operations](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/api-ref.html#api-overview). For information about the IAM access control permissions you need to use this API, see [IAM roles for Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/iam-roles.html)in the Amazon Q Business User Guide. The following resources provide additional information about using the Amazon Q Business API: - [Setting up for Amazon Q Business](https://docs.aws.amazon.com/amazonq/latest/business-use-dg/setting-up.html) - [Amazon Q Business CLI Reference](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/qbusiness/index.html) - [AWS General Reference](https://docs.aws.amazon.com/general/latest/gr/amazonq.html) ### Actions - [AssociatePermission](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AssociatePermission.md) - [BatchDeleteDocument](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchDeleteDocument.md) - [BatchPutDocument](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.md) - [CancelSubscription](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CancelSubscription.md) - [Chat](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Chat.md) - [ChatSync](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ChatSync.md) - [CheckDocumentAccess](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CheckDocumentAccess.md) - [CreateAnonymousWebExperienceUrl](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateAnonymousWebExperienceUrl.md) - [CreateApplication](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateApplication.md) - [CreateChatResponseConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateChatResponseConfiguration.md) - [CreateDataAccessor](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataAccessor.md) - [CreateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.md) - [CreateIndex](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateIndex.md) - [CreatePlugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreatePlugin.md) - [CreateRetriever](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateRetriever.md) - [CreateSubscription](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateSubscription.md) - [CreateUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateUser.md) - [CreateWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateWebExperience.md) - [DeleteApplication](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteApplication.md) - [DeleteAttachment](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteAttachment.md) - [DeleteChatControlsConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteChatControlsConfiguration.md) - [DeleteChatResponseConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteChatResponseConfiguration.md) - [DeleteConversation](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteConversation.md) - [DeleteDataAccessor](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteDataAccessor.md) - [DeleteDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteDataSource.md) - [DeleteGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteGroup.md) - [DeleteIndex](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteIndex.md) - [DeletePlugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeletePlugin.md) - [DeleteRetriever](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteRetriever.md) - [DeleteUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteUser.md) - [DeleteWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteWebExperience.md) - [DisassociatePermission](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DisassociatePermission.md) - [GetApplication](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetApplication.md) - [GetChatControlsConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetChatControlsConfiguration.md) - [GetChatResponseConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetChatResponseConfiguration.md) - [GetDataAccessor](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetDataAccessor.md) - [GetDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetDataSource.md) - [GetDocumentContent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetDocumentContent.md) - [GetGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetGroup.md) - [GetIndex](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetIndex.md) - [GetMedia](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetMedia.md) - [GetPlugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetPlugin.md) - [GetPolicy](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetPolicy.md) - [GetRetriever](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetRetriever.md) - [GetUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetUser.md) - [GetWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GetWebExperience.md) - [ListApplications](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListApplications.md) - [ListAttachments](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListAttachments.md) - [ListChatResponseConfigurations](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListChatResponseConfigurations.md) - [ListConversations](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListConversations.md) - [ListDataAccessors](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListDataAccessors.md) - [ListDataSources](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListDataSources.md) - [ListDataSourceSyncJobs](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListDataSourceSyncJobs.md) - [ListDocuments](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListDocuments.md) - [ListGroups](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListGroups.md) - [ListIndices](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListIndices.md) - [ListMessages](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListMessages.md) - [ListPluginActions](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListPluginActions.md) - [ListPlugins](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListPlugins.md) - [ListPluginTypeActions](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListPluginTypeActions.md) - [ListPluginTypeMetadata](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListPluginTypeMetadata.md) - [ListRetrievers](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListRetrievers.md) - [ListSubscriptions](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListSubscriptions.md) - [ListTagsForResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListTagsForResource.md) - [ListWebExperiences](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ListWebExperiences.md) - [PutFeedback](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PutFeedback.md) - [PutGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PutGroup.md) - [SearchRelevantContent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SearchRelevantContent.md) - [StartDataSourceSyncJob](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_StartDataSourceSyncJob.md) - [StopDataSourceSyncJob](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_StopDataSourceSyncJob.md) - [TagResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TagResource.md) - [UntagResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UntagResource.md) - [UpdateApplication](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateApplication.md) - [UpdateChatControlsConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateChatControlsConfiguration.md) - [UpdateChatResponseConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateChatResponseConfiguration.md) - [UpdateDataAccessor](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateDataAccessor.md) - [UpdateDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateDataSource.md) - [UpdateIndex](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.md) - [UpdatePlugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdatePlugin.md) - [UpdateRetriever](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateRetriever.md) - [UpdateSubscription](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateSubscription.md) - [UpdateUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateUser.md) - [UpdateWebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateWebExperience.md) ### Data Types - [AccessConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AccessConfiguration.md): Used to configure access permissions for a document. - [AccessControl](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AccessControl.md): A list of principals. - [ActionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionConfiguration.md): Specifies an allowed action and its associated filter configuration. - [ActionExecution](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionExecution.md): Performs an Amazon Q Business plugin action during a non-streaming chat conversation. - [ActionExecutionEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionExecutionEvent.md): A request from an end user signalling an intent to perform an Amazon Q Business plugin action during a streaming chat. - [ActionExecutionPayloadField](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionExecutionPayloadField.md): A user input field in an plugin action execution payload. - [ActionFilterConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionFilterConfiguration.md): Specifies filters to apply to an allowed action. - [ActionReview](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionReview.md): An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. - [ActionReviewEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionReviewEvent.md): An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a streaming chat conversation. - [ActionReviewPayloadField](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionReviewPayloadField.md): A user input field in an plugin action review payload. - [ActionReviewPayloadFieldAllowedValue](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionReviewPayloadFieldAllowedValue.md): 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. - [ActionSummary](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ActionSummary.md): Summary information for an Amazon Q Business plugin action. - [APISchema](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_APISchema.md): Contains details about the OpenAPI schema for a custom plugin. - [Application](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Application.md): Summary information for an Amazon Q Business application. - [AppliedAttachmentsConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AppliedAttachmentsConfiguration.md): Configuration information about the file upload during chat feature for your application. - [AppliedCreatorModeConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AppliedCreatorModeConfiguration.md): The creator mode specific admin controls configured for an Amazon Q Business application. - [AppliedOrchestrationConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AppliedOrchestrationConfiguration.md): The chat orchestration specific admin controls configured for an Amazon Q Business application. - [AssociatedGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AssociatedGroup.md): Represents a group associated with a given user in the access control system. - [AssociatedUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AssociatedUser.md): Represents an associated user in the access control system. - [Attachment](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Attachment.md): An attachment in an Amazon Q Business conversation. - [AttachmentInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AttachmentInput.md): This is either a file directly uploaded into a web experience chat or a reference to an existing attachment that is part of a web experience chat. - [AttachmentInputEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AttachmentInputEvent.md): A file input event activated by a end user request to upload files into their web experience chat. - [AttachmentOutput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AttachmentOutput.md): The details of a file uploaded during chat. - [AttachmentsConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AttachmentsConfiguration.md): Configuration information for the file upload during chat feature. - [AttributeFilter](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AttributeFilter.md): Enables filtering of responses based on document attributes or metadata fields. - [AudioExtractionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AudioExtractionConfiguration.md): Configuration settings for audio content extraction and processing. - [AudioSourceDetails](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AudioSourceDetails.md): Details about an audio source, including its identifier, format, and time information. - [AuthChallengeRequest](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AuthChallengeRequest.md): A request made by Amazon Q Business to a third paty authentication server to authenticate a custom plugin user. - [AuthChallengeRequestEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AuthChallengeRequestEvent.md): An authentication verification event activated by an end user request to use a custom plugin. - [AuthChallengeResponse](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AuthChallengeResponse.md): Contains details of the authentication information received from a third party authentication server in response to an authentication challenge. - [AuthChallengeResponseEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AuthChallengeResponseEvent.md): An authentication verification event response by a third party authentication server to Amazon Q Business. - [AutoSubscriptionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_AutoSubscriptionConfiguration.md): Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. - [BasicAuthConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BasicAuthConfiguration.md): Information about the basic authentication credentials used to configure a plugin. - [BlockedPhrasesConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BlockedPhrasesConfiguration.md): Provides information about the phrases blocked from chat by your chat control configuration. - [BlockedPhrasesConfigurationUpdate](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BlockedPhrasesConfigurationUpdate.md): Updates a blocked phrases configuration in your Amazon Q Business application. - [BrowserExtensionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BrowserExtensionConfiguration.md): The container for browser extension configuration for an Amazon Q Business web experience. - [ChatInputStream](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ChatInputStream.md): The streaming input for the Chat API. - [ChatModeConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ChatModeConfiguration.md): Configuration information for Amazon Q Business conversation modes. - [ChatOutputStream](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ChatOutputStream.md): The streaming output for the Chat API. - [ChatResponseConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ChatResponseConfiguration.md): Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. - [ChatResponseConfigurationDetail](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ChatResponseConfigurationDetail.md): Detailed information about a chat response configuration, including comprehensive settings and parameters that define how Amazon Q Business generates and formats responses. - [ConfigurationEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ConfigurationEvent.md): A configuration event activated by an end user request to select a specific chat mode. - [ContentBlockerRule](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ContentBlockerRule.md): A rule for configuring how Amazon Q Business responds when it encounters a a blocked topic. - [ContentRetrievalRule](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ContentRetrievalRule.md): Rules for retrieving content from data sources connected to a Amazon Q Business application for a specific topic control configuration. - [ContentSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ContentSource.md): Specifies the source of content to search in. - [Conversation](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Conversation.md): A conversation in an Amazon Q Business application. - [ConversationSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ConversationSource.md): The source reference for an existing attachment in an existing conversation. - [CopyFromSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CopyFromSource.md): The source reference for an existing attachment. - [CreatorModeConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreatorModeConfiguration.md): Configuration information required to invoke chat in CREATOR_MODE. - [CustomizationConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CustomizationConfiguration.md): Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all. - [CustomPluginConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CustomPluginConfiguration.md): Configuration information required to create a custom plugin. - [DataAccessor](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataAccessor.md): Provides summary information about a data accessor. - [DataAccessorAuthenticationConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataAccessorAuthenticationConfiguration.md): A union type that contains the specific authentication configuration based on the authentication type selected. - [DataAccessorAuthenticationDetail](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataAccessorAuthenticationDetail.md): Contains the authentication configuration details for a data accessor. - [DataAccessorIdcTrustedTokenIssuerConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataAccessorIdcTrustedTokenIssuerConfiguration.md): Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication. - [DataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataSource.md): A data source in an Amazon Q Business application. - [DataSourceSyncJob](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataSourceSyncJob.md): Provides information about an Amazon Q Business data source connector synchronization job. - [DataSourceSyncJobMetrics](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataSourceSyncJobMetrics.md): Maps a batch delete document request to a specific Amazon Q Business data source connector sync job. - [DataSourceVpcConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DataSourceVpcConfiguration.md): Provides configuration information needed to connect to an Amazon VPC (Virtual Private Cloud). - [DateAttributeBoostingConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DateAttributeBoostingConfiguration.md): Provides information on boosting DATE type document attributes. - [DeleteDocument](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DeleteDocument.md) - [Document](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Document.md): A document in an Amazon Q Business application. - [DocumentAcl](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAcl.md): Represents the Access Control List (ACL) for a document, containing both allowlist and denylist conditions. - [DocumentAclCondition](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAclCondition.md): Represents a condition in the document's ACL, specifying access rules for users and groups. - [DocumentAclGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAclGroup.md): Represents a group in the document's ACL, used to define access permissions for multiple users collectively. - [DocumentAclMembership](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAclMembership.md): Represents membership rules in the document's ACL, defining how users or groups are associated with access permissions. - [DocumentAclUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAclUser.md): Represents a user in the document's ACL, used to define access permissions for individual users. - [DocumentAttribute](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttribute.md): A document attribute or metadata field. - [DocumentAttributeBoostingConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeBoostingConfiguration.md): Provides information on boosting supported Amazon Q Business document attribute types. - [DocumentAttributeCondition](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.md): The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. - [DocumentAttributeConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.md): Configuration information for document attributes. - [DocumentAttributeTarget](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.md): The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business. - [DocumentAttributeValue](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.md): The value of a document attribute. - [DocumentContent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentContent.md): The contents of a document. - [DocumentDetails](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentDetails.md): The details of a document within an Amazon Q Business index. - [DocumentEnrichmentConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.md): Provides the configuration information for altering document metadata and content during the document ingestion process. - [EligibleDataSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_EligibleDataSource.md): The identifier of the data source Amazon Q Business will generate responses from. - [EncryptionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_EncryptionConfiguration.md): Provides the identifier of the AWS KMS key used to encrypt data indexed by Amazon Q Business. - [EndOfInputEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_EndOfInputEvent.md): The end of the streaming input for the Chat API. - [ErrorDetail](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ErrorDetail.md): Provides information about a Amazon Q Business request error. - [FailedAttachmentEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_FailedAttachmentEvent.md): A failed file upload during web experience chat. - [FailedDocument](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_FailedDocument.md): A list of documents that could not be removed from an Amazon Q Business index. - [GroupMembers](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GroupMembers.md): A list of users or sub groups that belong to a group. - [GroupStatusDetail](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GroupStatusDetail.md): Provides the details of a group's status. - [GroupSummary](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_GroupSummary.md): Summary information for groups. - [HallucinationReductionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HallucinationReductionConfiguration.md): Configuration information required to setup hallucination reduction. - [HookConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.md): Provides the configuration information for invoking a Lambda function in AWS Lambda to alter document metadata and content when ingesting documents into Amazon Q Business. - [IdcAuthConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_IdcAuthConfiguration.md): Information about the AWS IAM Identity Center Application used to configure authentication for a plugin. - [IdentityProviderConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_IdentityProviderConfiguration.md): Provides information about the identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. - [ImageExtractionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ImageExtractionConfiguration.md): The configuration for extracting semantic meaning from images in documents. - [ImageSourceDetails](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ImageSourceDetails.md): Details about an image source, including its identifier and format. - [Index](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Index.md): Summary information for your Amazon Q Business index. - [IndexCapacityConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_IndexCapacityConfiguration.md): Provides information about index capacity configuration. - [IndexStatistics](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_IndexStatistics.md): Provides information about the number of documents in an index. - [InlineDocumentEnrichmentConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_InlineDocumentEnrichmentConfiguration.md): Provides the configuration information for applying basic logic to alter document metadata and content when ingesting documents into Amazon Q Business. - [InstructionCollection](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_InstructionCollection.md): A set of instructions that define how Amazon Q Business should generate and format responses to user queries. - [KendraIndexConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_KendraIndexConfiguration.md): Stores an Amazon Kendra index as a retriever. - [MediaExtractionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_MediaExtractionConfiguration.md): The configuration for extracting information from media in documents. - [MemberGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_MemberGroup.md): The sub groups that belong to a group. - [MemberUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_MemberUser.md): The users that belong to a group. - [Message](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Message.md): A message in an Amazon Q Business web experience. - [MessageUsefulnessFeedback](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_MessageUsefulnessFeedback.md): End user feedback on an AI-generated web experience chat message usefulness. - [MetadataEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_MetadataEvent.md): A metadata event for a AI-generated text output message in a Amazon Q Business conversation, containing associated metadata generated. - [NativeIndexConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_NativeIndexConfiguration.md): Configuration information for an Amazon Q Business index. - [NoAuthConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_NoAuthConfiguration.md): Information about invoking a custom plugin without any authentication or authorization requirement. - [NumberAttributeBoostingConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_NumberAttributeBoostingConfiguration.md): Provides information on boosting NUMBER type document attributes. - [OAuth2ClientCredentialConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_OAuth2ClientCredentialConfiguration.md): Information about the OAuth 2.0 authentication credential/token used to configure a plugin. - [OpenIDConnectProviderConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_OpenIDConnectProviderConfiguration.md): Information about the OIDC-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. - [OrchestrationConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_OrchestrationConfiguration.md): Configuration information required to enable chat orchestration for your Amazon Q Business application. - [PermissionCondition](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PermissionCondition.md): Defines a condition that restricts when a permission is effective. - [PersonalizationConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PersonalizationConfiguration.md): Configuration information about chat response personalization. - [Plugin](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Plugin.md): Information about an Amazon Q Business plugin and its configuration. - [PluginAuthConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PluginAuthConfiguration.md): Authentication configuration information for an Amazon Q Business plugin. - [PluginConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PluginConfiguration.md): Configuration information required to invoke chat in PLUGIN_MODE. - [PluginTypeMetadataSummary](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PluginTypeMetadataSummary.md): Summary metadata information for a Amazon Q Business plugin. - [Principal](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Principal.md): Provides user and group information used for filtering documents to use for generating Amazon Q Business conversation responses. - [PrincipalGroup](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PrincipalGroup.md): Provides information about a group associated with the principal. - [PrincipalUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_PrincipalUser.md): Provides information about a user associated with a principal. - [QAppsConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_QAppsConfiguration.md): Configuration information about Amazon Q Apps. - [QuickSightConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_QuickSightConfiguration.md): The Amazon Quick configuration for an Amazon Q Business application that uses Quick as the identity provider. - [RelevantContent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_RelevantContent.md): Represents a piece of content that is relevant to a search query. - [ResponseConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ResponseConfiguration.md): Configuration settings to define how Amazon Q Business generates and formats responses to user queries. - [Retriever](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Retriever.md): Summary information for the retriever used for your Amazon Q Business application. - [RetrieverConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_RetrieverConfiguration.md): Provides information on how the retriever used for your Amazon Q Business application is configured. - [RetrieverContentSource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_RetrieverContentSource.md): Specifies a retriever as the content source for a search. - [Rule](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Rule.md): Guardrail rules for an Amazon Q Business application. - [RuleConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_RuleConfiguration.md): Provides configuration information about a rule. - [S3](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_S3.md): Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket. - [SamlConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SamlConfiguration.md): Provides the SAML 2.0 compliant identity provider (IdP) configuration information Amazon Q Business needs to deploy a Amazon Q Business web experience. - [SamlProviderConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SamlProviderConfiguration.md): Information about the SAML 2.0-compliant identity provider (IdP) used to authenticate end users of an Amazon Q Business web experience. - [ScoreAttributes](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ScoreAttributes.md): Provides information about the relevance score of content. - [SnippetExcerpt](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SnippetExcerpt.md): 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](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SourceAttribution.md): The documents used to generate an Amazon Q Business web experience response. - [SourceDetails](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SourceDetails.md): Container for details about different types of media sources (image, audio, or video). - [StringAttributeBoostingConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_StringAttributeBoostingConfiguration.md): Provides information on boosting STRING type document attributes. - [StringListAttributeBoostingConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_StringListAttributeBoostingConfiguration.md): Provides information on boosting STRING_LIST type document attributes. - [Subscription](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Subscription.md): Information about an Amazon Q Business subscription. - [SubscriptionDetails](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SubscriptionDetails.md): The details of an Amazon Q Business subscription. - [SubscriptionPrincipal](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_SubscriptionPrincipal.md): A user or group in the IAM Identity Center instance connected to the Amazon Q Business application. - [Tag](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Tag.md): A list of key/value pairs that identify an index, FAQ, or data source. - [TextDocumentStatistics](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TextDocumentStatistics.md): Provides information about text documents in an index. - [TextInputEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TextInputEvent.md): An input event for a end user message in an Amazon Q Business web experience. - [TextOutputEvent](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TextOutputEvent.md): An output event for an AI-generated response in an Amazon Q Business web experience. - [TextSegment](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TextSegment.md): Provides information about a text extract in a chat response that can be attributed to a source document. - [TopicConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_TopicConfiguration.md): The topic specific controls configured for an Amazon Q Business application. - [UserAlias](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UserAlias.md): Aliases attached to a user id within an Amazon Q Business application. - [UsersAndGroups](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UsersAndGroups.md): Provides information about users and group names associated with a topic control rule. - [ValidationExceptionField](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_ValidationExceptionField.md): The input failed to meet the constraints specified by Amazon Q Business in a specified field. - [VideoExtractionConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_VideoExtractionConfiguration.md): Configuration settings for video content extraction and processing. - [VideoSourceDetails](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_VideoSourceDetails.md): Details about a video source, including its identifier, format, and time information. - [WebExperience](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_WebExperience.md): Provides information for an Amazon Q Business web experience. - [WebExperienceAuthConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_WebExperienceAuthConfiguration.md): Provides the authorization configuration information needed to deploy a Amazon Q Business web experience to end users. ## [QApps](https://docs.aws.amazon.com/amazonq/latest/api-reference/Welcome_QApps.md) The Amazon Q Apps feature capability within Amazon Q Business allows web experience users to create lightweight, purpose-built AI apps to fulfill specific tasks from within their web experience. For example, users can create a Q App that exclusively generates marketing-related content to improve your marketing team's productivity or a Q App for writing customer emails and creating promotional content using a certain style of voice, tone, and branding. For more information on the capabilities, see [Amazon Q Apps capabilities](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html#q-apps-actions)in the Amazon Q Business User Guide. For an overview of the Amazon Q App APIs, see [Overview of Amazon Q Apps API operations](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_Operations_QApps.html). For information about the IAM access control permissions you need to use the Amazon Q Apps API, see [IAM role for the Amazon Q Business web experience including Amazon Q Apps](https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/deploy-experience-iam-role.html)in the Amazon Q Business User Guide. ### Actions - [AssociateLibraryItemReview](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_AssociateLibraryItemReview.md): Associates a rating or review for a library item with the user submitting the request. - [AssociateQAppWithUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_AssociateQAppWithUser.md): This operation creates a link between the user's identity calling the operation and a specific Q App. - [BatchCreateCategory](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_BatchCreateCategory.md): Creates Categories for the Amazon Q Business application environment instance. - [BatchDeleteCategory](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_BatchDeleteCategory.md): Deletes Categories for the Amazon Q Business application environment instance. - [BatchUpdateCategory](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_BatchUpdateCategory.md): Updates Categories for the Amazon Q Business application environment instance. - [CreateLibraryItem](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CreateLibraryItem.md): Creates a new library item for an Amazon Q App, allowing it to be discovered and used by other allowed users. - [CreatePresignedUrl](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CreatePresignedUrl.md): Creates a presigned URL for an S3 POST operation to upload a file. - [CreateQApp](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CreateQApp.md): Creates a new Amazon Q App based on the provided definition. - [DeleteLibraryItem](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DeleteLibraryItem.md): Deletes a library item for an Amazon Q App, removing it from the library so it can no longer be discovered or used by other users. - [DeleteQApp](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DeleteQApp.md): Deletes an Amazon Q App owned by the user. - [DescribeQAppPermissions](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DescribeQAppPermissions.md): Describes read permissions for a Amazon Q App in Amazon Q Business application environment instance. - [DisassociateLibraryItemReview](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DisassociateLibraryItemReview.md): Removes a rating or review previously submitted by the user for a library item. - [DisassociateQAppFromUser](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DisassociateQAppFromUser.md): Disassociates a Q App from a user removing the user's access to run the Q App. - [ExportQAppSessionData](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ExportQAppSessionData.md): Exports the collected data of a Q App data collection session. - [GetLibraryItem](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_GetLibraryItem.md): Retrieves details about a library item for an Amazon Q App, including its metadata, categories, ratings, and usage statistics. - [GetQApp](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_GetQApp.md): Retrieves the full details of an Q App, including its definition specifying the cards and flow. - [GetQAppSession](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_GetQAppSession.md): Retrieves the current state and results for an active session of an Amazon Q App. - [GetQAppSessionMetadata](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_GetQAppSessionMetadata.md): Retrieves the current configuration of a Q App session. - [ImportDocument](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ImportDocument.md): Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. - [ListCategories](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ListCategories.md): Lists the categories of a Amazon Q Business application environment instance. - [ListLibraryItems](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ListLibraryItems.md): Lists the library items for Amazon Q Apps that are published and available for users in your AWS account. - [ListQApps](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ListQApps.md): Lists the Amazon Q Apps owned by or associated with the user either because they created it or because they used it from the library in the past. - [ListQAppSessionData](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ListQAppSessionData.md): Lists the collected data of a Q App data collection session. - [ListTagsForResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ListTagsForResource.md): Lists the tags associated with an Amazon Q Apps resource. - [PredictQApp](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_PredictQApp.md): Generates an Amazon Q App definition based on either a conversation or a problem statement provided as input.The resulting app definition can be used to call CreateQApp. - [StartQAppSession](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_StartQAppSession.md): Starts a new session for an Amazon Q App, allowing inputs to be provided and the app to be run. - [StopQAppSession](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_StopQAppSession.md): Stops an active session for an Amazon Q App.This deletes all data related to the session and makes it invalid for future uses. - [TagResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_TagResource.md): Associates tags with an Amazon Q Apps resource. - [UntagResource](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UntagResource.md): Disassociates tags from an Amazon Q Apps resource. - [UpdateLibraryItem](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UpdateLibraryItem.md): Updates the library item for an Amazon Q App. - [UpdateLibraryItemMetadata](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UpdateLibraryItemMetadata.md): Updates the verification status of a library item for an Amazon Q App. - [UpdateQApp](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UpdateQApp.md): Updates an existing Amazon Q App, allowing modifications to its title, description, and definition. - [UpdateQAppPermissions](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UpdateQAppPermissions.md): Updates read permissions for a Amazon Q App in Amazon Q Business application environment instance. - [UpdateQAppSession](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UpdateQAppSession.md): Updates the session for a given Q App sessionId. - [UpdateQAppSessionMetadata](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UpdateQAppSessionMetadata.md): Updates the configuration metadata of a session for a given Q App sessionId. ### Data Types - [AppDefinition](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_AppDefinition.md): The definition of the Q App, specifying the cards and flow. - [AppDefinitionInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_AppDefinitionInput.md): The input for defining an Q App. - [AttributeFilter](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_AttributeFilter.md): The filter criteria used on responses based on document attributes or metadata fields. - [BatchCreateCategoryInputCategory](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_BatchCreateCategoryInputCategory.md): The category object to be created. - [Card](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_Card.md): A card representing a component or step in an Amazon Q App's flow. - [CardInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CardInput.md): The properties defining an input card in an Amazon Q App. - [CardStatus](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CardStatus.md): The current status and value of a card in an active Amazon Q App session. - [CardValue](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CardValue.md): The value or result associated with a card in a Amazon Q App session. - [Category](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_Category.md): A category used to classify and filter library items for Amazon Q Apps. - [CategoryInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_CategoryInput.md): A label that web experience users associate with a library item. - [ConversationMessage](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_ConversationMessage.md): A message in a conversation, used as input for generating an Amazon Q App definition. - [DocumentAttribute](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DocumentAttribute.md): A document attribute or metadata field. - [DocumentAttributeValue](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_DocumentAttributeValue.md): The value of a document attribute. - [FileUploadCard](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_FileUploadCard.md): A card in an Amazon Q App that allows the user to upload a file. - [FileUploadCardInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_FileUploadCardInput.md): Represents a file upload card. - [FormInputCard](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_FormInputCard.md): A card in an Amazon Q App that allows the user to submit a response. - [FormInputCardInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_FormInputCardInput.md): Represents a form input card for an Amazon Q App. - [FormInputCardMetadata](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_FormInputCardMetadata.md): The metadata of the form input card. - [LibraryItemMember](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_LibraryItemMember.md): 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. - [PermissionInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_PermissionInput.md): The permission to grant or revoke for a Amazon Q App. - [PermissionOutput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_PermissionOutput.md): The permission granted to the Amazon Q App. - [PredictAppDefinition](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_PredictAppDefinition.md): The definition of an Amazon Q App generated based on input such as a conversation or problem statement. - [PredictQAppInputOptions](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_PredictQAppInputOptions.md): The input options for generating an Q App definition. - [PrincipalOutput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_PrincipalOutput.md): The principal for which the permission applies. - [QAppSessionData](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_QAppSessionData.md): The response collected for a Amazon Q App session. - [QPluginCard](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_QPluginCard.md): A card in an Q App that integrates with a third-party plugin or service. - [QPluginCardInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_QPluginCardInput.md): The input shape for defining a plugin card in an Amazon Q App. - [QQueryCard](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_QQueryCard.md): A card in a Amazon Q App that generates a response based on the Amazon Q Business service. - [QQueryCardInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_QQueryCardInput.md): The input shape for defining a query card in an Amazon Q App. - [SessionSharingConfiguration](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_SessionSharingConfiguration.md): The sharing configuration of an Amazon Q App data collection session. - [Submission](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_Submission.md): A record created when a user submits a form card. - [SubmissionMutation](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_SubmissionMutation.md): Represents an action performed on a submission. - [TextInputCard](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_TextInputCard.md): A card in an Amazon Q App that allows the user to input text. - [TextInputCardInput](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_TextInputCardInput.md): The input shape for defining a text input card in an Amazon Q App. - [User](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_User.md): A user of an Amazon Q App. - [UserAppItem](https://docs.aws.amazon.com/amazonq/latest/api-reference/API_qapps_UserAppItem.md): An Amazon Q App associated with a user, either owned by the user or favorited. ## Common - [Common Parameters](https://docs.aws.amazon.com/amazonq/latest/api-reference/CommonParameters.md) - [Common Error Types](https://docs.aws.amazon.com/amazonq/latest/api-reference/CommonErrors.md) ## Full content The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass: - [Complete guide (single file)](https://docs.aws.amazon.com/amazonq/latest/api-reference/full.md)