View a markdown version of this page

Creating Amazon Q Business plugins using APIs - Amazon Q Business

Amazon Q Business will no longer be open to new customers starting on July 31, 2026. If you would like to use the service, please sign up prior to July 30. For capabilities similar to Q Business, explore Amazon Quick. Learn more.

Creating Amazon Q Business plugins using APIs

Amazon Q Business supports plugin creation through both the console and the APIs.

API action API description Relevant User Guide topic
CreatePlugin Creates an Amazon Q Business plugin Configuring plugins with Amazon Q Business
DeletePlugin Deletes an Amazon Q Business plugin Deleting a plugin
GetPlugin Gets information about an existing Amazon Q Business plugin Getting plugin properties
UpdatePlugin Updates an Amazon Q Business plugin Updating a plugin
ListPlugins Lists properties of an Amazon Q Business plugin Listing plugins
ListPluginActions Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application. Returns empty responses for custom and legacy built-in plugins. Listing configured plugin actions
ListPluginTypeActions Lists configured Amazon Q Business actions for any plugin type. Returns empty responses for custom and legacy built-in plugins. Listing available plugin actions
ListPluginTypeMetadata Lists metadata for all Amazon Q Business plugin types. Returns empty responses for custom and legacy built-in plugins. Listing plugin metadata