AWS SDK for JavaScript Bedrock Agentcore Client for Node.js, Browser and React Native
npm install @aws-sdk/client-bedrock-agentcoreAWS SDK for JavaScript BedrockAgentCore Client for Node.js, Browser and React Native.
Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.
npm install @aws-sdk/client-bedrock-agentcoreyarn add @aws-sdk/client-bedrock-agentcorepnpm add @aws-sdk/client-bedrock-agentcoreThe AWS SDK is modulized by clients and commands.
To send a request, you only need to import the BedrockAgentCoreClient and
the commands you need, for example ListActorsCommand:
``js`
// ES5 example
const { BedrockAgentCoreClient, ListActorsCommand } = require("@aws-sdk/client-bedrock-agentcore");
`ts`
// ES6+ example
import { BedrockAgentCoreClient, ListActorsCommand } from "@aws-sdk/client-bedrock-agentcore";
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.destroy()
- If you are using a custom http handler, you may call to close open connections.
`js
// a client can be shared by different commands.
const client = new BedrockAgentCoreClient({ region: "REGION" });
const params = { /* input parameters / };
const command = new ListActorsCommand(params);
`
#### Async/await
We recommend using 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
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,
but they are supported by the send operation.
`js`
// 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
`ts
import * as AWS from "@aws-sdk/client-bedrock-agentcore";
const client = new AWS.BedrockAgentCore({ region: "REGION" });
// async/await.
try {
const data = await client.listActors(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listActors(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks.
client.listActors(params, (err, data) => {
// process err and data.
});
`
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;
* }
*/
}
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.
This client code is generated automatically. Any modifications will be overwritten the next time the @aws-sdk/client-bedrock-agentcore` package is updated.
To contribute to client you can check our generate clients scripts.
This SDK is distributed under the
Apache License, Version 2.0,
see LICENSE for more information.
BatchCreateMemoryRecords
Command API Reference / Input / Output
BatchDeleteMemoryRecords
Command API Reference / Input / Output
BatchUpdateMemoryRecords
Command API Reference / Input / Output
CompleteResourceTokenAuth
Command API Reference / Input / Output
CreateEvent
Command API Reference / Input / Output
DeleteEvent
Command API Reference / Input / Output
DeleteMemoryRecord
Command API Reference / Input / Output
Evaluate
Command API Reference / Input / Output
GetAgentCard
Command API Reference / Input / Output
GetBrowserSession
Command API Reference / Input / Output
GetCodeInterpreterSession
Command API Reference / Input / Output
GetEvent
Command API Reference / Input / Output
GetMemoryRecord
Command API Reference / Input / Output
GetResourceApiKey
Command API Reference / Input / Output
GetResourceOauth2Token
Command API Reference / Input / Output
GetWorkloadAccessToken
Command API Reference / Input / Output
GetWorkloadAccessTokenForJWT
Command API Reference / Input / Output
GetWorkloadAccessTokenForUserId
Command API Reference / Input / Output
InvokeAgentRuntime
Command API Reference / Input / Output
InvokeCodeInterpreter
Command API Reference / Input / Output
ListActors
Command API Reference / Input / Output
ListBrowserSessions
Command API Reference / Input / Output
ListCodeInterpreterSessions
Command API Reference / Input / Output
ListEvents
Command API Reference / Input / Output
ListMemoryExtractionJobs
Command API Reference / Input / Output
ListMemoryRecords
Command API Reference / Input / Output
ListSessions
Command API Reference / Input / Output
RetrieveMemoryRecords
Command API Reference / Input / Output
SaveBrowserSessionProfile
Command API Reference / Input / Output
StartBrowserSession
Command API Reference / Input / Output
StartCodeInterpreterSession
Command API Reference / Input / Output
StartMemoryExtractionJob
Command API Reference / Input / Output
StopBrowserSession
Command API Reference / Input / Output
StopCodeInterpreterSession
Command API Reference / Input / Output
StopRuntimeSession
Command API Reference / Input / Output
UpdateBrowserStream