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

****************
ListApplications
****************



.. py:class:: QBusiness.Paginator.ListApplications

  ::

    
    paginator = client.get_paginator('list_applications')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'applications': [
                {
                    'displayName': 'string',
                    'applicationId': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'updatedAt': datetime(2015, 1, 1),
                    'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING',
                    'identityType': 'AWS_IAM_IDP_SAML'|'AWS_IAM_IDP_OIDC'|'AWS_IAM_IDC'|'AWS_QUICKSIGHT_IDP'|'ANONYMOUS',
                    'quickSightConfiguration': {
                        'clientNamespace': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **applications** *(list) --* 

          An array of summary information on the configuration of one or more Amazon Q Business applications.

          
          

          - *(dict) --* 

            Summary information for an Amazon Q Business application.

            
            

            - **displayName** *(string) --* 

              The name of the Amazon Q Business application.

              
            

            - **applicationId** *(string) --* 

              The identifier for the Amazon Q Business application.

              
            

            - **createdAt** *(datetime) --* 

              The Unix timestamp when the Amazon Q Business application was created.

              
            

            - **updatedAt** *(datetime) --* 

              The Unix timestamp when the Amazon Q Business application was last updated.

              
            

            - **status** *(string) --* 

              The status of the Amazon Q Business application. The application is ready to use when the status is ``ACTIVE``.

              
            

            - **identityType** *(string) --* 

              The authentication type being used by a Amazon Q Business application.

              
            

            - **quickSightConfiguration** *(dict) --* 

              The Amazon Quick Suite configuration for an Amazon Q Business application that uses Quick Suite as the identity provider.

              
              

              - **clientNamespace** *(string) --* 

                The Amazon Quick Suite namespace that is used as the identity provider. For more information about Quick Suite namespaces, see `Namespace operations <https://docs.aws.amazon.com/quicksight/latest/developerguide/namespace-operations.html>`__.

                
          
        
      
        

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

          A token to resume pagination.

          
    