Data retrieval APIs for Amazon Q Business
Amazon Q Business provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| Chat | Chat using an application | Read |
| ChatSync | Chat synchronously using an application | Read |
| CheckDocumentAccess | Check if a user has access to a document | Read |
| GetApplication | Get an application | Read |
| GetChatControlsConfiguration | Get chat controls configuration for an application | List |
| GetChatResponseConfiguration | Get a chat response configuration | Read |
| GetDataAccessor | Get DataAccessor | Read |
| GetDataSource | Get a data source | Read |
| GetDocumentContent | Get a document content | Read |
| GetGroup | Get a group | Read |
| GetIndex | Get an index | Read |
| GetIntegration | Get an integration for a Q Business application | Read |
| GetMedia | Get the media associated to a system message | Read |
| GetPlugin | Get a plugin | Read |
| GetPolicy | Get resource based policy of the application | Read |
| GetRetriever | Get a retriever | Read |
| GetUser | Get a user | Read |
| GetWebExperience | Get a web-experience | Read |
| ListApplications | List the applications | List |
| ListAttachments | List attachments in the current chat context | List |
| ListChatResponseConfigurations | List chat response configurations for an application | List |
| ListConversations | List all conversations for an application | List |
| ListDataAccessors | List DataAccessors for the application | List |
| ListDataSourceSyncJobs | Get Data Source sync job history | List |
| ListDataSources | List the data sources of an application and an index | List |
| ListDocuments | List all documents | List |
| ListGroups | List groups | List |
| ListIndices | List the indices of an application | List |
| ListIntegrations | List all integrations for a Q Business application | List |
| ListMessages | List all messages | List |
| ListPluginActions | List the plugins actions of a plugin within application | Read |
| ListPluginTypeActions | List all the actions for a plugin type | Read |
| ListPluginTypeMetadata | List all the plugin type metadata | Read |
| ListPlugins | List the plugins of an application | List |
| ListRetrievers | List the retrievers of an application | List |
| ListSubscriptions | List subscriptions | List |
| ListTagsForResource | List tags for a resource | Read |
| ListWebExperiences | List the web experiences of an application | List |
| SearchRelevantContent | Search relevant content from the Amazon Q Business Application | Read |
