:doc:`QBusiness <../../qbusiness>` / Client / list_subscriptions

******************
list_subscriptions
******************



.. py:method:: QBusiness.Client.list_subscriptions(**kwargs)

  

  Lists all subscriptions created in an Amazon Q Business application.

  

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


  **Request Syntax**
  ::

    response = client.list_subscriptions(
        applicationId='string',
        nextToken='string',
        maxResults=123
    )
    
  :type applicationId: string
  :param applicationId: **[REQUIRED]** 

    The identifier of the Amazon Q Business application linked to the subscription.

    

  
  :type nextToken: string
  :param nextToken: 

    If the ``maxResults`` response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of Amazon Q Business subscriptions to return.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **nextToken** *(string) --* 

        If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.

        
      

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

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`QBusiness.Client.exceptions.InternalServerException`

  
  *   :py:class:`QBusiness.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`QBusiness.Client.exceptions.ConflictException`

  
  *   :py:class:`QBusiness.Client.exceptions.ThrottlingException`

  
  *   :py:class:`QBusiness.Client.exceptions.ValidationException`

  
  *   :py:class:`QBusiness.Client.exceptions.AccessDeniedException`

  