QBusiness / Client / list_plugin_type_metadata

list_plugin_type_metadata¶

QBusiness.Client.list_plugin_type_metadata(**kwargs)¶

Lists metadata for all Amazon Q Business plugin types.

Request Syntax

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

Parameters:

nextToken (string) – If the metadata returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.
maxResults (integer) – The maximum number of plugin metadata items to return.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'items': [
        {
            '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',
            'category': 'Customer relationship management (CRM)'|'Project management'|'Communication'|'Productivity'|'Ticketing and incident management',
            '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 metadata.
- items (list) –
  
  An array of information on plugin metadata.
  - (dict) –
    
    Summary metadata information for a Amazon Q Business plugin.
    - type (string) –
      
      The type of the plugin.
    - category (string) –
      
      The category of the plugin type.
    - description (string) –
      
      The description assigned by Amazon Q Business to a plugin. You can’t modify this value.

Exceptions

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