S3Vectors / Client / delete_vectors

delete_vectors

S3Vectors.Client.delete_vectors(**kwargs)

Note

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

Deletes one or more vectors in a vector index. To specify the vector index, you can either use both the vector bucket name and vector index name, or use the vector index Amazon Resource Name (ARN).

Permissions

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

See also: AWS API Documentation

Request Syntax

response = client.delete_vectors(
    vectorBucketName='string',
    indexName='string',
    indexArn='string',
    keys=[
        'string',
    ]
)
Parameters:

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

  • indexName (string) – The name of the vector index that contains a vector you want to delete.

  • indexArn (string) – The ARN of the vector index that contains a vector you want to delete.

  • keys (list) –

    [REQUIRED]

    The keys of the vectors to delete.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions