@aws-sdk/client-lex-runtime-service/README.md

AWS SDK for JavaScript Lex Runtime Service Client for Node.js, Browser and React Native

# @aws-sdk/client-lex-runtime-service

[![NPM version](https://img.shields.io/npm/v/@aws-sdk/client-lex-runtime-service/latest.svg)](https://www.npmjs.com/package/@aws-sdk/client-lex-runtime-service)
[![NPM downloads](https://img.shields.io/npm/dm/@aws-sdk/client-lex-runtime-service.svg)](https://www.npmjs.com/package/@aws-sdk/client-lex-runtime-service)

## Description

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

<p>Amazon Lex provides both build and runtime endpoints. Each endpoint provides a set of
operations (API). Your conversational bot uses the runtime API to understand user utterances
(user input text or voice). For example, suppose a user says "I want pizza", your bot sends
this input to Amazon Lex using the runtime API. Amazon Lex recognizes that the user request is
for the OrderPizza intent (one of the intents defined in the bot). Then Amazon Lex engages in
user conversation on behalf of the bot to elicit required information (slot values, such as
pizza size and crust type), and then performs fulfillment activity (that you configured when
you created the bot). You use the build-time API to create and manage your Amazon Lex bot. For
a list of build-time operations, see the build-time API, . </p>

## Installing

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

- `npm install @aws-sdk/client-lex-runtime-service`
- `yarn add @aws-sdk/client-lex-runtime-service`
- `pnpm add @aws-sdk/client-lex-runtime-service`

## Getting Started

### Import

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

```js
// ES5 example
const { LexRuntimeServiceClient, DeleteSessionCommand } = require("@aws-sdk/client-lex-runtime-service");
```

```ts
// ES6+ example
import { LexRuntimeServiceClient, DeleteSessionCommand } from "@aws-sdk/client-lex-runtime-service";
```

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

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

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

#### Async/await

We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#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](http://callbackhell.com/),
but they are supported by the send operation.

```js
// callbacks.
client.send(command, (err, data) => {
  // proccess 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](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)

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

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

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

// callbacks.
client.deleteSession(params, (err, data) => {
  // proccess 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).

```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](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
  on AWS Developer Blog.
- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.
- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).
- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).

To test your universal JavaScript code in Node.js, browser and react-native environments,
visit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).

## Contributing

This client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-lex-runtime-service` package is updated.
To contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).

## License

This SDK is distributed under the
[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),
see LICENSE for more information.