:doc:`S3Vectors <../../s3vectors>` / Client / list_indexes

************
list_indexes
************



.. py:method:: S3Vectors.Client.list_indexes(**kwargs)

  

  Returns a list of all the vector indexes within the specified vector bucket. To specify the bucket, you must use either the vector bucket name or the vector bucket Amazon Resource Name (ARN).

    Permissions  

  You must have the ``s3vectors:ListIndexes`` permission to use this operation.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/s3vectors-2025-07-15/ListIndexes>`_  


  **Request Syntax**
  ::

    response = client.list_indexes(
        vectorBucketName='string',
        vectorBucketArn='string',
        maxResults=123,
        nextToken='string',
        prefix='string'
    )
    
  :type vectorBucketName: string
  :param vectorBucketName: 

    The name of the vector bucket that contains the vector indexes.

    

  
  :type vectorBucketArn: string
  :param vectorBucketArn: 

    The ARN of the vector bucket that contains the vector indexes.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of items to be returned in the response.

    

  
  :type nextToken: string
  :param nextToken: 

    The previous pagination token.

    

  
  :type prefix: string
  :param prefix: 

    Limits the response to vector indexes that begin with the specified prefix.

    

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

    
    ::

      {
          'nextToken': 'string',
          'indexes': [
              {
                  'vectorBucketName': 'string',
                  'indexName': 'string',
                  'indexArn': 'string',
                  'creationTime': datetime(2015, 1, 1)
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The next pagination token.

        
      

      - **indexes** *(list) --* 

        The attributes of the vector indexes

        
        

        - *(dict) --* 

          Summary information about a vector index.

          
          

          - **vectorBucketName** *(string) --* 

            The name of the vector bucket that contains the vector index.

            
          

          - **indexName** *(string) --* 

            The name of the vector index.

            
          

          - **indexArn** *(string) --* 

            The Amazon Resource Name (ARN) of the vector index.

            
          

          - **creationTime** *(datetime) --* 

            Date and time when the vector index was created.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`S3Vectors.Client.exceptions.ValidationException`

  
  *   :py:class:`S3Vectors.Client.exceptions.ServiceUnavailableException`

  
  *   :py:class:`S3Vectors.Client.exceptions.TooManyRequestsException`

  
  *   :py:class:`S3Vectors.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`S3Vectors.Client.exceptions.RequestTimeoutException`

  
  *   :py:class:`S3Vectors.Client.exceptions.NotFoundException`

  