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

************
list_indices
************



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

  

  Lists the Amazon Q Business indices you have created.

  

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


  **Request Syntax**
  ::

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

    The identifier of the Amazon Q Business application connected to the index.

    

  
  :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 indices.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of indices to return.

    

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

    
    ::

      {
          'nextToken': 'string',
          'indices': [
              {
                  'displayName': 'string',
                  'indexId': 'string',
                  'createdAt': datetime(2015, 1, 1),
                  'updatedAt': datetime(2015, 1, 1),
                  'status': 'CREATING'|'ACTIVE'|'DELETING'|'FAILED'|'UPDATING'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of indexes.

        
      

      - **indices** *(list) --* 

        An array of information on the items in one or more indexes.

        
        

        - *(dict) --* 

          Summary information for your Amazon Q Business index.

          
          

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

            The name of the index.

            
          

          - **indexId** *(string) --* 

            The identifier for the index.

            
          

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

            The Unix timestamp when the index was created.

            
          

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

            The Unix timestamp when the index was last updated.

            
          

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

            The current status of the index. When the status is ``ACTIVE``, the index is ready.

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

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

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

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

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

  