:doc:`QBusiness <../../qbusiness>` / Paginator / ListPlugins

***********
ListPlugins
***********



.. py:class:: QBusiness.Paginator.ListPlugins

  ::

    
    paginator = client.get_paginator('list_plugins')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`QBusiness.Client.list_plugins`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListPlugins>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          applicationId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type applicationId: string
    :param applicationId: **[REQUIRED]** 

      The identifier of the application the plugin is attached to.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            '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)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **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.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    