S3Vectors / Client / get_index

get_index

S3Vectors.Client.get_index(**kwargs)

Note

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

Returns vector index attributes. To specify the vector index, you can either use both the vector bucket name and the vector index name, or use the vector index Amazon Resource Name (ARN).

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.get_index(
    vectorBucketName='string',
    indexName='string',
    indexArn='string'
)
Parameters:

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

  • indexName (string) – The name of the vector index.

  • indexArn (string) – The ARN of the vector index.

Return type:

dict

Returns:

Response Syntax

{
    'index': {
        'vectorBucketName': 'string',
        'indexName': 'string',
        'indexArn': 'string',
        'creationTime': datetime(2015, 1, 1),
        'dataType': 'float32',
        'dimension': 123,
        'distanceMetric': 'euclidean'|'cosine',
        'metadataConfiguration': {
            'nonFilterableMetadataKeys': [
                'string',
            ]
        }
    }
}

Response Structure

  • (dict) –

    • index (dict) –

      The attributes of the 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.

      • dataType (string) –

        The data type of the vectors inserted into the vector index.

      • dimension (integer) –

        The number of values in the vectors that are inserted into the vector index.

      • distanceMetric (string) –

        The distance metric to be used for similarity search.

      • metadataConfiguration (dict) –

        The metadata configuration for the vector index.

        • nonFilterableMetadataKeys (list) –

          Non-filterable metadata keys allow you to enrich vectors with additional context during storage and retrieval. Unlike default metadata keys, these keys can’t be used as query filters. Non-filterable metadata keys can be retrieved but can’t be searched, queried, or filtered. You can access non-filterable metadata keys of your vectors after finding the vectors. For more information about non-filterable metadata keys, see Vectors and Limitations and restrictions in the Amazon S3 User Guide.

          • (string) –

Exceptions