QBusiness / Client / list_plugin_type_actions

list_plugin_type_actions¶

QBusiness.Client.list_plugin_type_actions(**kwargs)¶

Lists configured Amazon Q Business actions for any plugin type—both built-in and custom.

Request Syntax

response = client.list_plugin_type_actions(
    pluginType='SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK'|'CUSTOM'|'QUICKSIGHT'|'SERVICENOW_NOW_PLATFORM'|'JIRA_CLOUD'|'SALESFORCE_CRM'|'ZENDESK_SUITE'|'ATLASSIAN_CONFLUENCE'|'GOOGLE_CALENDAR'|'MICROSOFT_TEAMS'|'MICROSOFT_EXCHANGE'|'PAGERDUTY_ADVANCE'|'SMARTSHEET'|'ASANA',
    nextToken='string',
    maxResults=123
)

Parameters:

pluginType (string) –
[REQUIRED]

The type of the plugin.
nextToken (string) – If the number of plugins returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.
maxResults (integer) – The maximum number of plugins 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 plugins.
- items (list) –
  
  An array of information on one or more plugins.
  - (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

QBusiness.Client.exceptions.InternalServerException
QBusiness.Client.exceptions.ThrottlingException
QBusiness.Client.exceptions.ValidationException
QBusiness.Client.exceptions.AccessDeniedException