:doc:`QBusiness <../../qbusiness>` / Client / list_plugin_actions

*******************
list_plugin_actions
*******************



.. py:method:: 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 <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPluginActions>`_  


  **Request Syntax**
  ::

    response = client.list_plugin_actions(
        applicationId='string',
        pluginId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type applicationId: string
  :param applicationId: **[REQUIRED]** 

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

    

  
  :type pluginId: string
  :param pluginId: **[REQUIRED]** 

    The identifier of the Amazon Q Business plugin.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of plugin actions to return.

    

  
  
  :rtype: 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**
  
  *   :py:class:`QBusiness.Client.exceptions.InternalServerException`

  
  *   :py:class:`QBusiness.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QBusiness.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QBusiness.Client.exceptions.ValidationException`

  
  *   :py:class:`QBusiness.Client.exceptions.AccessDeniedException`

  