Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@aws-sdk/client-bedrock-agent

Package Overview
Dependencies
Maintainers
5
Versions
121
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@aws-sdk/client-bedrock-agent

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

  • 3.509.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
39K
increased by49.39%
Maintainers
5
Weekly downloads
 
Created
Source

@aws-sdk/client-bedrock-agent

Description

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

An example service, deployed with the Octane Service creator, which will echo the string

Installing

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

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

Getting Started

Import

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

// ES5 example
const { BedrockAgentClient, ListAgentsCommand } = require("@aws-sdk/client-bedrock-agent");
// ES6+ example
import { BedrockAgentClient, ListAgentsCommand } from "@aws-sdk/client-bedrock-agent";

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

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

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

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

// callbacks.
client.listAgents(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.

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-bedrock-agent 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)

AssociateAgentKnowledgeBase

Command API Reference / Input / Output

CreateAgent

Command API Reference / Input / Output

CreateAgentActionGroup

Command API Reference / Input / Output

CreateAgentAlias

Command API Reference / Input / Output

CreateDataSource

Command API Reference / Input / Output

CreateKnowledgeBase

Command API Reference / Input / Output

DeleteAgent

Command API Reference / Input / Output

DeleteAgentActionGroup

Command API Reference / Input / Output

DeleteAgentAlias

Command API Reference / Input / Output

DeleteAgentVersion

Command API Reference / Input / Output

DeleteDataSource

Command API Reference / Input / Output

DeleteKnowledgeBase

Command API Reference / Input / Output

DisassociateAgentKnowledgeBase

Command API Reference / Input / Output

GetAgent

Command API Reference / Input / Output

GetAgentActionGroup

Command API Reference / Input / Output

GetAgentAlias

Command API Reference / Input / Output

GetAgentKnowledgeBase

Command API Reference / Input / Output

GetAgentVersion

Command API Reference / Input / Output

GetDataSource

Command API Reference / Input / Output

GetIngestionJob

Command API Reference / Input / Output

GetKnowledgeBase

Command API Reference / Input / Output

ListAgentActionGroups

Command API Reference / Input / Output

ListAgentAliases

Command API Reference / Input / Output

ListAgentKnowledgeBases

Command API Reference / Input / Output

ListAgents

Command API Reference / Input / Output

ListAgentVersions

Command API Reference / Input / Output

ListDataSources

Command API Reference / Input / Output

ListIngestionJobs

Command API Reference / Input / Output

ListKnowledgeBases

Command API Reference / Input / Output

ListTagsForResource

Command API Reference / Input / Output

PrepareAgent

Command API Reference / Input / Output

StartIngestionJob

Command API Reference / Input / Output

TagResource

Command API Reference / Input / Output

UntagResource

Command API Reference / Input / Output

UpdateAgent

Command API Reference / Input / Output

UpdateAgentActionGroup

Command API Reference / Input / Output

UpdateAgentAlias

Command API Reference / Input / Output

UpdateAgentKnowledgeBase

Command API Reference / Input / Output

UpdateDataSource

Command API Reference / Input / Output

UpdateKnowledgeBase

Command API Reference / Input / Output

FAQs

Package last updated on 07 Feb 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc