S3Vectors / Paginator / ListIndexes

ListIndexes

class S3Vectors.Paginator.ListIndexes

paginator = client.get_paginator('list_indexes')

paginate(**kwargs)

Creates an iterator that will paginate through responses from S3Vectors.Client.list_indexes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    vectorBucketName='string',
    vectorBucketArn='string',
    prefix='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• vectorBucketName (string) – The name of the vector bucket that contains the vector indexes.

• vectorBucketArn (string) – The ARN of the vector bucket that contains the vector indexes.

• prefix (string) – Limits the response to vector indexes that begin with the specified prefix.

• PaginationConfig (dict) –

  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.

Return type:

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) –

      Note

      Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.

      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.