QBusiness / Client / list_plugins

list_plugins#

QBusiness.Client.list_plugins(**kwargs)#

Lists configured Amazon Q Business plugins.

Request Syntax

response = client.list_plugins(
    applicationId='string',
    nextToken='string',
    maxResults=123
)

Parameters:

applicationId (string) –
[REQUIRED]

The identifier of the application the plugin is attached to.
nextToken (string) – If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
maxResults (integer) – The maximum number of documents to return.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'plugins': [
        {
            'pluginId': 'string',
            'displayName': 'string',
            'type': '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',
            'serverUrl': 'string',
            'state': 'ENABLED'|'DISABLED',
            'buildStatus': 'READY'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –
- nextToken (string) –
  
  If the maxResults response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
- plugins (list) –
  
  Information about a configured plugin.
  - (dict) –
    
    Information about an Amazon Q Business plugin and its configuration.
    - pluginId (string) –
      
      The identifier of the plugin.
    - displayName (string) –
      
      The name of the plugin.
    - type (string) –
      
      The type of the plugin.
    - serverUrl (string) –
      
      The plugin server URL used for configuration.
    - state (string) –
      
      The current status of the plugin.
    - buildStatus (string) –
      
      The status of the plugin.
    - createdAt (datetime) –
      
      The timestamp for when the plugin was created.
    - updatedAt (datetime) –
      
      The timestamp for when the plugin was last updated.

Exceptions

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