QBusiness / Paginator / ListPluginTypeActions

ListPluginTypeActions¶

class QBusiness.Paginator.ListPluginTypeActions ¶

paginator = client.get_paginator('list_plugin_type_actions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from QBusiness.Client.list_plugin_type_actions().

Request Syntax

response_iterator = paginator.paginate(
    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',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

pluginType (string) –
[REQUIRED]

The type of the plugin.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

(dict) –
- 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.
- NextToken (string) –
  
  A token to resume pagination.