AWS SDK for JavaScript Opensearchserverless Client for Node.js, Browser and React Native
npm install @aws-sdk/client-opensearchserverlessAWS SDK for JavaScript OpenSearchServerless Client for Node.js, Browser and React Native.
Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.
OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.
To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?
npm install @aws-sdk/client-opensearchserverlessyarn add @aws-sdk/client-opensearchserverlesspnpm add @aws-sdk/client-opensearchserverlessThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the OpenSearchServerlessClient and
the commands you need, for example ListCollectionsCommand:
``js`
// ES5 example
const { OpenSearchServerlessClient, ListCollectionsCommand } = require("@aws-sdk/client-opensearchserverless");
`ts`
// ES6+ example
import { OpenSearchServerlessClient, ListCollectionsCommand } from "@aws-sdk/client-opensearchserverless";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new OpenSearchServerlessClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListCollectionsCommand(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-opensearchserverless";
const client = new AWS.OpenSearchServerless({ region: "REGION" });
// async/await.
try {
const data = await client.listCollections(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listCollections(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listCollections(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-opensearchserverless` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
BatchGetCollection
Command API Reference / Input / Output
BatchGetCollectionGroup
Command API Reference / Input / Output
BatchGetEffectiveLifecyclePolicy
Command API Reference / Input / Output
BatchGetLifecyclePolicy
Command API Reference / Input / Output
BatchGetVpcEndpoint
Command API Reference / Input / Output
CreateAccessPolicy
Command API Reference / Input / Output
CreateCollection
Command API Reference / Input / Output
CreateCollectionGroup
Command API Reference / Input / Output
CreateIndex
Command API Reference / Input / Output
CreateLifecyclePolicy
Command API Reference / Input / Output
CreateSecurityConfig
Command API Reference / Input / Output
CreateSecurityPolicy
Command API Reference / Input / Output
CreateVpcEndpoint
Command API Reference / Input / Output
DeleteAccessPolicy
Command API Reference / Input / Output
DeleteCollection
Command API Reference / Input / Output
DeleteCollectionGroup
Command API Reference / Input / Output
DeleteIndex
Command API Reference / Input / Output
DeleteLifecyclePolicy
Command API Reference / Input / Output
DeleteSecurityConfig
Command API Reference / Input / Output
DeleteSecurityPolicy
Command API Reference / Input / Output
DeleteVpcEndpoint
Command API Reference / Input / Output
GetAccessPolicy
Command API Reference / Input / Output
GetAccountSettings
Command API Reference / Input / Output
GetIndex
Command API Reference / Input / Output
GetPoliciesStats
Command API Reference / Input / Output
GetSecurityConfig
Command API Reference / Input / Output
GetSecurityPolicy
Command API Reference / Input / Output
ListAccessPolicies
Command API Reference / Input / Output
ListCollectionGroups
Command API Reference / Input / Output
ListCollections
Command API Reference / Input / Output
ListLifecyclePolicies
Command API Reference / Input / Output
ListSecurityConfigs
Command API Reference / Input / Output
ListSecurityPolicies
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
ListVpcEndpoints
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateAccessPolicy
Command API Reference / Input / Output
UpdateAccountSettings
Command API Reference / Input / Output
UpdateCollection
Command API Reference / Input / Output
UpdateCollectionGroup
Command API Reference / Input / Output
UpdateIndex
Command API Reference / Input / Output
UpdateLifecyclePolicy
Command API Reference / Input / Output
UpdateSecurityConfig
Command API Reference / Input / Output
UpdateSecurityPolicy
Command API Reference / Input / Output
UpdateVpcEndpoint