:doc:`S3Vectors <../../s3vectors>` / Paginator / ListIndexes

***********
ListIndexes
***********



.. py:class:: S3Vectors.Paginator.ListIndexes

  ::

    
    paginator = client.get_paginator('list_indexes')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`S3Vectors.Client.list_indexes`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          vectorBucketName='string',
          vectorBucketArn='string',
          prefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 prefix: string
    :param prefix: 

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

      

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

      
      ::

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

      

      - *(dict) --* 
        

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

              
        
      
        

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

          A token to resume pagination.

          
    