QBusiness / Client / list_plugins
list_plugins#
- QBusiness.Client.list_plugins(**kwargs)#
Lists configured Amazon Q plugins.
See also: AWS API Documentation
Request Syntax
response = client.list_plugins( applicationId='string', maxResults=123, nextToken='string' )
- Parameters:
applicationId (string) –
[REQUIRED]
The identifier of the application the plugin is attached to.
maxResults (integer) – The maximum number of documents to return.
nextToken (string) – If the
maxResults
response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of plugins.
- Return type:
dict
- Returns:
Response Syntax
{ 'nextToken': 'string', 'plugins': [ { 'createdAt': datetime(2015, 1, 1), 'displayName': 'string', 'pluginId': 'string', 'serverUrl': 'string', 'state': 'ENABLED'|'DISABLED', 'type': 'SERVICE_NOW'|'SALESFORCE'|'JIRA'|'ZENDESK', '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 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 plugin and its configuration.
createdAt (datetime) –
The timestamp for when the plugin was created.
displayName (string) –
The name of the plugin.
pluginId (string) –
The identifier of the plugin.
serverUrl (string) –
The plugin server URL used for configuration.
state (string) –
The current status of the plugin.
type (string) –
The type of the plugin.
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