plugin_actions

Creates, updates, deletes, gets or lists a plugin_actions resource.

Overview

Name	plugin_actions
Type	Resource
Id	aws.qbusiness.plugin_actions

Fields

The following fields are returned by SELECT queries:

list_plugin_actions

Name	Datatype	Description
action_identifier	string	The identifier of an Amazon Q Business plugin action.
description	string	The description of an Amazon Q Business plugin action.
display_name	string	The display name assigned by Amazon Q Business to a plugin action. You can't modify this value.
instruction_example	string	An Amazon Q Business suggested prompt and end user can use to invoke a plugin action. This value can be modified and sent as input to initiate an action. For example: Create a Jira task Create a chat assistant task to find the root cause of a specific incident

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_plugin_actions	select	application_id, plugin_id, region	nextToken, maxResults	Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
application_id	string	The identifier of the Amazon Q Business application the plugin is attached to.
plugin_id	string	The identifier of the Amazon Q Business plugin.
region	string	AWS region (default: us-east-1)
maxResults	integer	The maximum number of plugin actions to return.
nextToken	string	If the number of plugin actions returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.

SELECT examples

list_plugin_actions

Lists configured Amazon Q Business actions for a specific plugin in an Amazon Q Business application.

SELECT
action_identifier,
description,
display_name,
instruction_example
FROM aws.qbusiness.plugin_actions
WHERE application_id = '{{ application_id }}' -- required
AND plugin_id = '{{ plugin_id }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;