S3Vectors / Client / list_indexes

list_indexes

S3Vectors.Client.list_indexes(**kwargs)

Note

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

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

Request Syntax

response = client.list_indexes(
    vectorBucketName='string',
    vectorBucketArn='string',
    maxResults=123,
    nextToken='string',
    prefix='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.

  • maxResults (integer) – The maximum number of items to be returned in the response.

  • nextToken (string) – The previous pagination token.

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

Return type:

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

        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.

Exceptions