@aws-sdk/client-opensearch

What is @aws-sdk/client-opensearch?

@aws-sdk/client-opensearch is an AWS SDK for JavaScript package that allows developers to interact with Amazon OpenSearch Service. It provides a set of APIs to manage and interact with OpenSearch domains, perform search operations, and manage indices and documents.

What are @aws-sdk/client-opensearch's main functionalities?

Create OpenSearch Domain

This feature allows you to create a new OpenSearch domain. The code sample demonstrates how to use the CreateDomainCommand to create a domain with specific configurations.

const { OpenSearchClient, CreateDomainCommand } = require('@aws-sdk/client-opensearch');

const client = new OpenSearchClient({ region: 'us-west-2' });

const createDomain = async () => {
  const params = {
    DomainName: 'my-domain',
    EngineVersion: 'OpenSearch_1.0',
    ClusterConfig: {
      InstanceType: 'm5.large.search',
      InstanceCount: 2
    }
  };
  const command = new CreateDomainCommand(params);
  const response = await client.send(command);
  console.log(response);
};

createDomain();

Index Document

This feature allows you to index a document into an OpenSearch index. The code sample demonstrates how to use the IndexDocumentCommand to add a document to a specified index.

const { OpenSearchClient, IndexDocumentCommand } = require('@aws-sdk/client-opensearch');

const client = new OpenSearchClient({ region: 'us-west-2' });

const indexDocument = async () => {
  const params = {
    DomainName: 'my-domain',
    IndexName: 'my-index',
    DocumentId: '1',
    Document: {
      title: 'Sample Document',
      content: 'This is a sample document.'
    }
  };
  const command = new IndexDocumentCommand(params);
  const response = await client.send(command);
  console.log(response);
};

indexDocument();

Search Documents

This feature allows you to search for documents within an OpenSearch index. The code sample demonstrates how to use the SearchCommand to perform a search query on a specified index.

const { OpenSearchClient, SearchCommand } = require('@aws-sdk/client-opensearch');

const client = new OpenSearchClient({ region: 'us-west-2' });

const searchDocuments = async () => {
  const params = {
    DomainName: 'my-domain',
    IndexName: 'my-index',
    Query: {
      match: {
        content: 'sample'
      }
    }
  };
  const command = new SearchCommand(params);
  const response = await client.send(command);
  console.log(response);
};

searchDocuments();

Other packages similar to @aws-sdk/client-opensearch

elasticsearch

The 'elasticsearch' npm package is an official client for Elasticsearch, which is a distributed search and analytics engine. It provides similar functionalities to @aws-sdk/client-opensearch, such as managing indices, indexing documents, and performing search operations. However, it is specifically designed for Elasticsearch and may not support all features of Amazon OpenSearch Service.

opensearch

The 'opensearch' npm package is an official client for OpenSearch, which is a community-driven, open-source search and analytics suite derived from Elasticsearch. It offers similar functionalities to @aws-sdk/client-opensearch, including managing indices, indexing documents, and performing search operations. This package is more aligned with the open-source OpenSearch project rather than the managed Amazon OpenSearch Service.

README

@aws-sdk/client-opensearch

Description

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

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

Installing

To install the this package, simply type add or install @aws-sdk/client-opensearch using your favorite package manager:

• npm install @aws-sdk/client-opensearch
• yarn add @aws-sdk/client-opensearch
• pnpm add @aws-sdk/client-opensearch

Getting Started

Import

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

// ES5 example
const { OpenSearchClient, ListDomainNamesCommand } = require("@aws-sdk/client-opensearch");

// ES6+ example
import { OpenSearchClient, ListDomainNamesCommand } from "@aws-sdk/client-opensearch";

Usage

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.

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

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

Async/await

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

// 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.

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

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

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.

// 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

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

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

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

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

Troubleshooting

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

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

AcceptInboundConnection

Command API Reference / Input / Output

AddDataSource

Command API Reference / Input / Output

AddTags

Command API Reference / Input / Output

AssociatePackage

Command API Reference / Input / Output

AuthorizeVpcEndpointAccess

Command API Reference / Input / Output

CancelDomainConfigChange

Command API Reference / Input / Output

CancelServiceSoftwareUpdate

Command API Reference / Input / Output

CreateDomain

Command API Reference / Input / Output

CreateOutboundConnection

Command API Reference / Input / Output

CreatePackage

Command API Reference / Input / Output

CreateVpcEndpoint

Command API Reference / Input / Output

DeleteDataSource

Command API Reference / Input / Output

DeleteDomain

Command API Reference / Input / Output

DeleteInboundConnection

Command API Reference / Input / Output

DeleteOutboundConnection

Command API Reference / Input / Output

DeletePackage

Command API Reference / Input / Output

DeleteVpcEndpoint

Command API Reference / Input / Output

DescribeDomain

Command API Reference / Input / Output

DescribeDomainAutoTunes

Command API Reference / Input / Output

DescribeDomainChangeProgress

Command API Reference / Input / Output

DescribeDomainConfig

Command API Reference / Input / Output

DescribeDomainHealth

Command API Reference / Input / Output

DescribeDomainNodes

Command API Reference / Input / Output

DescribeDomains

Command API Reference / Input / Output

DescribeDryRunProgress

Command API Reference / Input / Output

DescribeInboundConnections

Command API Reference / Input / Output

DescribeInstanceTypeLimits

Command API Reference / Input / Output

DescribeOutboundConnections

Command API Reference / Input / Output

DescribePackages

Command API Reference / Input / Output

DescribeReservedInstanceOfferings

Command API Reference / Input / Output

DescribeReservedInstances

Command API Reference / Input / Output

DescribeVpcEndpoints

Command API Reference / Input / Output

DissociatePackage

Command API Reference / Input / Output

GetCompatibleVersions

Command API Reference / Input / Output

GetDataSource

Command API Reference / Input / Output

GetDomainMaintenanceStatus

Command API Reference / Input / Output

GetPackageVersionHistory

Command API Reference / Input / Output

GetUpgradeHistory

Command API Reference / Input / Output

GetUpgradeStatus

Command API Reference / Input / Output

ListDataSources

Command API Reference / Input / Output

ListDomainMaintenances

Command API Reference / Input / Output

ListDomainNames

Command API Reference / Input / Output

ListDomainsForPackage

Command API Reference / Input / Output

ListInstanceTypeDetails

Command API Reference / Input / Output

ListPackagesForDomain

Command API Reference / Input / Output

ListScheduledActions

Command API Reference / Input / Output

ListTags

Command API Reference / Input / Output

ListVersions

Command API Reference / Input / Output

ListVpcEndpointAccess

Command API Reference / Input / Output

ListVpcEndpoints

Command API Reference / Input / Output

ListVpcEndpointsForDomain

Command API Reference / Input / Output

PurchaseReservedInstanceOffering

Command API Reference / Input / Output

RejectInboundConnection

Command API Reference / Input / Output

RemoveTags

Command API Reference / Input / Output

RevokeVpcEndpointAccess

Command API Reference / Input / Output

StartDomainMaintenance

Command API Reference / Input / Output

StartServiceSoftwareUpdate

Command API Reference / Input / Output

UpdateDataSource

Command API Reference / Input / Output

UpdateDomainConfig

Command API Reference / Input / Output

UpdatePackage

Command API Reference / Input / Output

UpdateScheduledAction

Command API Reference / Input / Output

UpdateVpcEndpoint

Command API Reference / Input / Output

UpgradeDomain

Command API Reference / Input / Output

Changelog

3.649.0 (2024-09-10)

Features

• client-cognito-identity: This release adds sensitive trait to some required shapes. (28a1dee)
• client-pipes: This release adds support for customer managed KMS keys in Amazon EventBridge Pipe (a0eda25)
• clients: update client endpoints as of 2024-09-10 (467fa98)
• endpoints: codegen sync for request creation performance improvements (#6449) (c8e8f28)