@aws-sdk/client-kendra

What is @aws-sdk/client-kendra?

@aws-sdk/client-kendra is an AWS SDK for JavaScript package that allows developers to interact with Amazon Kendra, a highly accurate and easy-to-use enterprise search service powered by machine learning. This package provides methods to create, manage, and query indexes, data sources, and other resources within Amazon Kendra.

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

Create Index

This feature allows you to create a new index in Amazon Kendra. The code sample demonstrates how to use the CreateIndexCommand to create an index with a specified name, role ARN, and edition.

const { KendraClient, CreateIndexCommand } = require('@aws-sdk/client-kendra');

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

const params = {
  Name: 'MyIndex',
  RoleArn: 'arn:aws:iam::123456789012:role/service-role/AmazonKendra-role',
  Edition: 'DEVELOPER_EDITION'
};

const run = async () => {
  try {
    const data = await client.send(new CreateIndexCommand(params));
    console.log('Index created:', data);
  } catch (err) {
    console.error('Error creating index:', err);
  }
};

run();

Query Index

This feature allows you to query an existing index in Amazon Kendra. The code sample demonstrates how to use the QueryCommand to search an index using a specified query text.

const { KendraClient, QueryCommand } = require('@aws-sdk/client-kendra');

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

const params = {
  IndexId: 'index-id',
  QueryText: 'search query'
};

const run = async () => {
  try {
    const data = await client.send(new QueryCommand(params));
    console.log('Query results:', data);
  } catch (err) {
    console.error('Error querying index:', err);
  }
};

run();

List Data Sources

This feature allows you to list all data sources associated with a specific index in Amazon Kendra. The code sample demonstrates how to use the ListDataSourcesCommand to retrieve and display the data sources.

const { KendraClient, ListDataSourcesCommand } = require('@aws-sdk/client-kendra');

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

const params = {
  IndexId: 'index-id'
};

const run = async () => {
  try {
    const data = await client.send(new ListDataSourcesCommand(params));
    console.log('Data sources:', data);
  } catch (err) {
    console.error('Error listing data sources:', err);
  }
};

run();

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

elasticsearch

The 'elasticsearch' npm package is a client for Elasticsearch, a distributed, RESTful search and analytics engine. It provides similar functionalities for creating and managing indexes, querying data, and handling data sources. However, Elasticsearch is a self-managed service, whereas Amazon Kendra is a fully managed service provided by AWS.

algoliasearch

The 'algoliasearch' npm package is a client for Algolia, a hosted search engine capable of delivering real-time results from the first keystroke. It offers functionalities for managing indexes and querying data similar to Amazon Kendra. Algolia is known for its speed and ease of integration, but it is a third-party service compared to the AWS-native Kendra.

typesense

The 'typesense' npm package is a client for Typesense, an open-source, typo-tolerant search engine optimized for instant search experiences. It provides similar functionalities for managing and querying indexes. Typesense is self-hosted and offers a different set of features and performance characteristics compared to the fully managed Amazon Kendra.

README

@aws-sdk/client-kendra

Description

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

Amazon Kendra is a service for indexing large document sets.

Installing

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

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

Getting Started

Import

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

// ES5 example
const { KendraClient, ListIndicesCommand } = require("@aws-sdk/client-kendra");

// ES6+ example
import { KendraClient, ListIndicesCommand } from "@aws-sdk/client-kendra";

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 KendraClient({ region: "REGION" });

const params = {
  /** input parameters */
};
const command = new ListIndicesCommand(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-kendra";
const client = new AWS.Kendra({ region: "REGION" });

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

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

// callbacks.
client.listIndices(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-kendra 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)

AssociateEntitiesToExperience

Command API Reference / Input / Output

AssociatePersonasToEntities

Command API Reference / Input / Output

BatchDeleteDocument

Command API Reference / Input / Output

BatchDeleteFeaturedResultsSet

Command API Reference / Input / Output

BatchGetDocumentStatus

Command API Reference / Input / Output

BatchPutDocument

Command API Reference / Input / Output

ClearQuerySuggestions

Command API Reference / Input / Output

CreateAccessControlConfiguration

Command API Reference / Input / Output

CreateDataSource

Command API Reference / Input / Output

CreateExperience

Command API Reference / Input / Output

CreateFaq

Command API Reference / Input / Output

CreateFeaturedResultsSet

Command API Reference / Input / Output

CreateIndex

Command API Reference / Input / Output

CreateQuerySuggestionsBlockList

Command API Reference / Input / Output

CreateThesaurus

Command API Reference / Input / Output

DeleteAccessControlConfiguration

Command API Reference / Input / Output

DeleteDataSource

Command API Reference / Input / Output

DeleteExperience

Command API Reference / Input / Output

DeleteFaq

Command API Reference / Input / Output

DeleteIndex

Command API Reference / Input / Output

DeletePrincipalMapping

Command API Reference / Input / Output

DeleteQuerySuggestionsBlockList

Command API Reference / Input / Output

DeleteThesaurus

Command API Reference / Input / Output

DescribeAccessControlConfiguration

Command API Reference / Input / Output

DescribeDataSource

Command API Reference / Input / Output

DescribeExperience

Command API Reference / Input / Output

DescribeFaq

Command API Reference / Input / Output

DescribeFeaturedResultsSet

Command API Reference / Input / Output

DescribeIndex

Command API Reference / Input / Output

DescribePrincipalMapping

Command API Reference / Input / Output

DescribeQuerySuggestionsBlockList

Command API Reference / Input / Output

DescribeQuerySuggestionsConfig

Command API Reference / Input / Output

DescribeThesaurus

Command API Reference / Input / Output

DisassociateEntitiesFromExperience

Command API Reference / Input / Output

DisassociatePersonasFromEntities

Command API Reference / Input / Output

GetQuerySuggestions

Command API Reference / Input / Output

GetSnapshots

Command API Reference / Input / Output

ListAccessControlConfigurations

Command API Reference / Input / Output

ListDataSources

Command API Reference / Input / Output

ListDataSourceSyncJobs

Command API Reference / Input / Output

ListEntityPersonas

Command API Reference / Input / Output

ListExperienceEntities

Command API Reference / Input / Output

ListExperiences

Command API Reference / Input / Output

ListFaqs

Command API Reference / Input / Output

ListFeaturedResultsSets

Command API Reference / Input / Output

ListGroupsOlderThanOrderingId

Command API Reference / Input / Output

ListIndices

Command API Reference / Input / Output

ListQuerySuggestionsBlockLists

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

ListThesauri

Command API Reference / Input / Output

PutPrincipalMapping

Command API Reference / Input / Output

Query

Command API Reference / Input / Output

Retrieve

Command API Reference / Input / Output

StartDataSourceSyncJob

Command API Reference / Input / Output

StopDataSourceSyncJob

Command API Reference / Input / Output

SubmitFeedback

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAccessControlConfiguration

Command API Reference / Input / Output

UpdateDataSource

Command API Reference / Input / Output

UpdateExperience

Command API Reference / Input / Output

UpdateFeaturedResultsSet

Command API Reference / Input / Output

UpdateIndex

Command API Reference / Input / Output

UpdateQuerySuggestionsBlockList

Command API Reference / Input / Output

UpdateQuerySuggestionsConfig

Command API Reference / Input / Output

UpdateThesaurus

Command API Reference / Input / Output

Changelog

3.692.0 (2024-11-14)

Features

• client-accessanalyzer: Expand analyzer configuration capabilities for unused access analyzers. Unused access analyzer configurations now support the ability to exclude accounts and resource tags from analysis providing more granular control over the scope of analysis. (b2df1e1)
• client-cloudcontrol: Added support for CloudFormation Hooks with Cloud Control API. The GetResourceRequestStatus API response now includes an optional HooksProgressEvent and HooksRequestToken parameter for Hooks Invocation Progress as part of resource operation with Cloud Control. (e90cde2)
• client-deadline: Adds support for select GPU accelerated instance types when creating new service-managed fleets. (ac3309b)
• client-iam: This release includes support for five new APIs and changes to existing APIs that give AWS Organizations customers the ability to use temporary root credentials, targeted to member accounts in the organization. (c9dfef1)
• client-iot-wireless: New FuotaTask resource type to enable logging for your FUOTA tasks. A ParticipatingGatewaysforMulticast parameter to choose the list of gateways to receive the multicast downlink message and the transmission interval between them. Descriptor field which will be sent to devices during FUOTA transfer. (69415e0)
• client-ivs: IVS now offers customers the ability to stream multitrack video to Channels. (84b6f4c)
• client-license-manager-user-subscriptions: New and updated API operations to support License Included User-based Subscription of Microsoft Remote Desktop Services (RDS). (5c7c349)
• client-partnercentral-selling: Announcing AWS Partner Central API for Selling: This service launch Introduces new APIs for co-selling opportunity management and related functions. Key features include notifications, a dynamic sandbox for testing, and streamlined validations. (07b84d2)
• client-quicksight: This release adds APIs for Custom Permissions management in QuickSight, and APIs to support QuickSight Branding. (81b1f8c)
• client-redshift: Adds support for Amazon Redshift S3AccessGrants (bf85814)
• client-s3: This release updates the ListBuckets API Reference documentation in support of the new 10,000 general purpose bucket default quota on all AWS accounts. To increase your bucket quota from 10,000 to up to 1 million buckets, simply request a quota increase via Service Quotas. (1e42456)
• client-sagemaker: Add support for Neuron instance types [ trn1/trn1n/inf2 ] on SageMaker Notebook Instances Platform. (dd44e8a)
• client-sts: This release introduces the new API 'AssumeRoot', which returns short-term credentials that you can use to perform privileged tasks. (5528f54)
• clients: update client endpoints as of 2024-11-14 (87df5bd)