QBusiness / Client / list_plugin_actions

list_plugin_actions#

QBusiness.Client.list_plugin_actions(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.list_plugin_actions(
    applicationId='string',
    pluginId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • applicationId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business application the plugin is attached to.

  • pluginId (string) –

    [REQUIRED]

    The identifier of the Amazon Q Business plugin.

  • 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.

  • maxResults (integer) – The maximum number of plugin actions to return.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            'actionIdentifier': 'string',
            'displayName': 'string',
            'instructionExample': 'string',
            'description': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.

    • items (list) –

      An array of information on one or more plugin actions.

      • (dict) –

        Summary information for an Amazon Q Business plugin action.

        • actionIdentifier (string) –

          The identifier of an Amazon Q Business plugin action.

        • displayName (string) –

          The display name assigned by Amazon Q Business to a plugin action. You can’t modify this value.

        • instructionExample (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

        • description (string) –

          The description of an Amazon Q Business plugin action.

Exceptions