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

*****************
ListSubscriptions
*****************



.. py:class:: QBusiness.Paginator.ListSubscriptions

  ::

    
    paginator = client.get_paginator('list_subscriptions')

  
  

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

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

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


    **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 Amazon Q Business application linked to the subscription.

      

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

      
      ::

        {
            'subscriptions': [
                {
                    'subscriptionId': 'string',
                    'subscriptionArn': 'string',
                    'principal': {
                        'user': 'string',
                        'group': 'string'
                    },
                    'currentSubscription': {
                        'type': 'Q_LITE'|'Q_BUSINESS'
                    },
                    'nextSubscription': {
                        'type': 'Q_LITE'|'Q_BUSINESS'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **subscriptions** *(list) --* 

          An array of summary information on the subscriptions configured for an Amazon Q Business application.

          
          

          - *(dict) --* 

            Information about an Amazon Q Business subscription.

             

            Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.

             

            Amazon Q Business offers two subscription tiers: ``Q_LITE`` and ``Q_BUSINESS``. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see `Amazon Q Business pricing <https://aws.amazon.com/q/business/pricing/>`__.

            
            

            - **subscriptionId** *(string) --* 

              The identifier of the Amazon Q Business subscription to be updated.

              
            

            - **subscriptionArn** *(string) --* 

              The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.

              
            

            - **principal** *(dict) --* 

              The IAM Identity Center ``UserId`` or ``GroupId`` of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.

              .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``user``, ``group``.     If a client receives an unknown member it will     set ``SDK_UNKNOWN_MEMBER`` as the top level key,     which maps to the name or tag of the unknown     member. The structure of ``SDK_UNKNOWN_MEMBER`` is     as follows::

                            'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}


            
              

              - **user** *(string) --* 

                The identifier of a user in the IAM Identity Center instance connected to the Amazon Q Business application.

                
              

              - **group** *(string) --* 

                The identifier of a group in the IAM Identity Center instance connected to the Amazon Q Business application.

                
          
            

            - **currentSubscription** *(dict) --* 

              The type of your current Amazon Q Business subscription.

              
              

              - **type** *(string) --* 

                The type of an Amazon Q Business subscription.

                
          
            

            - **nextSubscription** *(dict) --* 

              The type of the Amazon Q Business subscription for the next month.

              
              

              - **type** *(string) --* 

                The type of an Amazon Q Business subscription.

                
          
        
      
        

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

          A token to resume pagination.

          
    