@aws-sdk/client-s3vectors

Description

AWS SDK for JavaScript S3Vectors Client for Node.js, Browser and React Native.

Amazon S3 vector buckets are a bucket type to store and search vectors with sub-second search times. They are designed to provide dedicated API operations for you to interact with vectors to do similarity search. Within a vector bucket, you use a vector index to organize and logically group your vector data. When you make a write or read request, you direct it to a single vector index. You store your vector data as vectors. A vector contains a key (a name that you assign), a multi-dimensional vector, and, optionally, metadata that describes a vector. The key uniquely identifies the vector in a vector index.

Installing

To install this package, simply type add or install @aws-sdk/client-s3vectors
using your favorite package manager:
- npm install @aws-sdk/client-s3vectors
- yarn add @aws-sdk/client-s3vectors
- pnpm add @aws-sdk/client-s3vectors

Getting Started

$3

The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the S3VectorsClient and
the commands you need, for example ListIndexesCommand:

``js
// ES5 example
const { S3VectorsClient, ListIndexesCommand } = require("@aws-sdk/client-s3vectors");
`

`ts
// ES6+ example
import { S3VectorsClient, ListIndexesCommand } from "@aws-sdk/client-s3vectors";
`

$3

To send a request, you:

- Initiate client with configuration (e.g. credentials, region).
- Initiate command with input parameters.
- Call send operation on client with command object as input.
- If you are using a custom http handler, you may call destroy() to close open connections.

`js
// a client can be shared by different commands.
const client = new S3VectorsClient({ region: "REGION" });

const params = { /* input parameters / };
const command = new ListIndexesCommand(params);
`

#### Async/await

We recommend using await
operator to wait for the promise returned by send operation as follows:

`js
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
`

Async-await is clean, concise, intuitive, easy to debug and has better error handling
as compared to using Promise chains or callbacks.

#### Promises

You can also use Promise chaining
to execute send operation.

`js
client.send(command).then(
(data) => {
// process data.
},
(error) => {
// error handling.
}
);
`

Promises can also be called using .catch() and .finally() as follows:

`js
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
`

#### Callbacks

We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.

`js
// callbacks.
client.send(command, (err, data) => {
// process err and data.
});
`

#### v2 compatible style

The client can also send requests using v2 compatible style.
However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
on modular packages in AWS SDK for JavaScript

`ts
import * as AWS from "@aws-sdk/client-s3vectors";
const client = new AWS.S3Vectors({ region: "REGION" });

// async/await.
try {
const data = await client.listIndexes(params);
// process data.
} catch (error) {
// error handling.
}

// Promises.
client
.listIndexes(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});

// callbacks.
client.listIndexes(params, (err, data) => {
// process err and data.
});
`

$3

When the service returns an exception, the error will include the exception information,
as well as response metadata (e.g. request id).

`js
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
`

Getting Help

Please use these community resources for getting help.
We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.

- Visit Developer Guide
or API Reference.
- Check out the blog posts tagged with aws-sdk-js
on AWS Developer Blog.
- Ask a question on StackOverflow and tag it with aws-sdk-js.
- Join the AWS JavaScript community on gitter.
- If it turns out that you may have found a bug, please open an issue.

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our code samples repo.

Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-s3vectors` package is updated.
To contribute to client you can check our generate clients scripts.

License

This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.

Client Commands (Operations List)

CreateIndex

Command API Reference / Input / Output

CreateVectorBucket

Command API Reference / Input / Output

DeleteIndex

Command API Reference / Input / Output

DeleteVectorBucket

Command API Reference / Input / Output

DeleteVectorBucketPolicy

Command API Reference / Input / Output

DeleteVectors

Command API Reference / Input / Output

GetIndex

Command API Reference / Input / Output

GetVectorBucket

Command API Reference / Input / Output

GetVectorBucketPolicy

Command API Reference / Input / Output

GetVectors

Command API Reference / Input / Output

ListIndexes

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListVectorBuckets

Command API Reference / Input / Output

ListVectors

Command API Reference / Input / Output

PutVectorBucketPolicy

Command API Reference / Input / Output

PutVectors

Command API Reference / Input / Output

QueryVectors

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output