QBusiness / Paginator / ListPlugins
ListPlugins#
- class QBusiness.Paginator.ListPlugins#
paginator = client.get_paginator('list_plugins')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
QBusiness.Client.list_plugins()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( applicationId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
applicationId (string) –
[REQUIRED]
The identifier of the application the plugin is attached to.
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
{ '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) }, ], 'NextToken': 'string' }
Response Structure
(dict) –
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.
NextToken (string) –
A token to resume pagination.