@aws-sdk/client-lex-models-v2

Description

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

This document provides detailed information about the Amazon Lex V2 API actions and their parameters.

For information about the IAM access control permissions you need to use this API, see Identity-based policies for Amazon Lex V2.

Amazon Lex V2 Model Building V2 operations let you build and manage bots.

If you use a custom HTTP client to call Amazon Lex Model Building V2 operations, you must set the "Content-Type" HTTP header to "application/x-amz-json-1.1". Otherwise, you receive an HTTP 404 - UnknownOperationException in the response.

Amazon Lex Model Building V2 operations return the responses with the "application/x-amz-json-1.1" content type.

You can use Amazon Web Services SDKs to access Amazon Lex V2 APIs using your favorite programming language. The SDKs automatically perform useful tasks for you, such as:

• Cryptographically sign your service requests

• Retry requests

• Handle error responses

The following resources provide additional information about the Amazon Lex V2 Model Building API.

• Amazon Web Services General Reference

  • Amazon Lex V2 Endpoints for each region.

• Command Line Interface

  • Amazon Lex Model Building V2 CLI commands.

Installing

To install this package, use the CLI of your favorite package manager:

• npm install @aws-sdk/client-lex-models-v2
• yarn add @aws-sdk/client-lex-models-v2
• pnpm add @aws-sdk/client-lex-models-v2

Getting Started

Import

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

// ES5 example
const { LexModelsV2Client, ListBotsCommand } = require("@aws-sdk/client-lex-models-v2");

// ES6+ example
import { LexModelsV2Client, ListBotsCommand } from "@aws-sdk/client-lex-models-v2";

Usage

To send a request:

• Instantiate a client with configuration (e.g. credentials, region).
  • See docs/CLIENTS for configuration details.
  • See @aws-sdk/config for additional options.
• Instantiate a command with input parameters.
• Call the send operation on the client, providing the command object as input.

const client = new LexModelsV2Client({ region: "REGION" });

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

Async/await

We recommend using the 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.
}

Promises

You can also use Promise chaining.

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

Aggregated client

The aggregated client class is exported from the same package, but without the "Client" suffix.

LexModelsV2 extends LexModelsV2Client and additionally supports all operations, waiters, and paginators as methods. This style may be familiar to you from the AWS SDK for JavaScript v2.

If you are bundling the AWS SDK, we recommend using only the bare-bones client (LexModelsV2Client). More details are in the blog post on modular packages in AWS SDK for JavaScript.

import { LexModelsV2 } from "@aws-sdk/client-lex-models-v2";

const client = new LexModelsV2({ region: "REGION" });

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

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

// callbacks (not recommended).
client.listBots(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;
   * }
   */
}

See also docs/ERROR_HANDLING.

Getting Help

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

• Visit the 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-lex-models-v2 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)