@aws-sdk/client-bedrock
Description
AWS SDK for JavaScript Bedrock Client for Node.js, Browser and React Native.
Describes the API operations for creating, managing, fine-turning, and evaluating Amazon Bedrock models.
Installing
To install this package, simply type add or install @aws-sdk/client-bedrock
using your favorite package manager:
npm install @aws-sdk/client-bedrock
yarn add @aws-sdk/client-bedrock
pnpm add @aws-sdk/client-bedrock
Getting Started
Import
The AWS SDK is modulized by clients and commands.
To send a request, you only need to import the BedrockClient
and
the commands you need, for example ListCustomModelsCommand
:
const { BedrockClient, ListCustomModelsCommand } = require("@aws-sdk/client-bedrock");
import { BedrockClient, ListCustomModelsCommand } from "@aws-sdk/client-bedrock";
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.
const client = new BedrockClient({ region: "REGION" });
const params = {
};
const command = new ListCustomModelsCommand(params);
Async/await
We recommend using await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} 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) => {
},
(error) => {
}
);
Promises can also be called using .catch()
and .finally()
as follows:
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
Callbacks
We do not recommend using callbacks because of callback hell,
but they are supported by the send operation.
client.send(command, (err, 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";
const client = new AWS.Bedrock({ region: "REGION" });
try {
const data = await client.listCustomModels(params);
} catch (error) {
}
client
.listCustomModels(params)
.then((data) => {
})
.catch((error) => {
});
client.listCustomModels(params, (err, 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);
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
}
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
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)
BatchDeleteEvaluationJob
Command API Reference / Input / Output
CreateEvaluationJob
Command API Reference / Input / Output
CreateGuardrail
Command API Reference / Input / Output
CreateGuardrailVersion
Command API Reference / Input / Output
CreateInferenceProfile
Command API Reference / Input / Output
CreateMarketplaceModelEndpoint
Command API Reference / Input / Output
CreateModelCopyJob
Command API Reference / Input / Output
CreateModelCustomizationJob
Command API Reference / Input / Output
CreateModelImportJob
Command API Reference / Input / Output
CreateModelInvocationJob
Command API Reference / Input / Output
CreateProvisionedModelThroughput
Command API Reference / Input / Output
DeleteCustomModel
Command API Reference / Input / Output
DeleteGuardrail
Command API Reference / Input / Output
DeleteImportedModel
Command API Reference / Input / Output
DeleteInferenceProfile
Command API Reference / Input / Output
DeleteMarketplaceModelEndpoint
Command API Reference / Input / Output
DeleteModelInvocationLoggingConfiguration
Command API Reference / Input / Output
DeleteProvisionedModelThroughput
Command API Reference / Input / Output
DeregisterMarketplaceModelEndpoint
Command API Reference / Input / Output
GetCustomModel
Command API Reference / Input / Output
GetEvaluationJob
Command API Reference / Input / Output
GetFoundationModel
Command API Reference / Input / Output
GetGuardrail
Command API Reference / Input / Output
GetImportedModel
Command API Reference / Input / Output
GetInferenceProfile
Command API Reference / Input / Output
GetMarketplaceModelEndpoint
Command API Reference / Input / Output
GetModelCopyJob
Command API Reference / Input / Output
GetModelCustomizationJob
Command API Reference / Input / Output
GetModelImportJob
Command API Reference / Input / Output
GetModelInvocationJob
Command API Reference / Input / Output
GetModelInvocationLoggingConfiguration
Command API Reference / Input / Output
GetPromptRouter
Command API Reference / Input / Output
GetProvisionedModelThroughput
Command API Reference / Input / Output
ListCustomModels
Command API Reference / Input / Output
ListEvaluationJobs
Command API Reference / Input / Output
ListFoundationModels
Command API Reference / Input / Output
ListGuardrails
Command API Reference / Input / Output
ListImportedModels
Command API Reference / Input / Output
ListInferenceProfiles
Command API Reference / Input / Output
ListMarketplaceModelEndpoints
Command API Reference / Input / Output
ListModelCopyJobs
Command API Reference / Input / Output
ListModelCustomizationJobs
Command API Reference / Input / Output
ListModelImportJobs
Command API Reference / Input / Output
ListModelInvocationJobs
Command API Reference / Input / Output
ListPromptRouters
Command API Reference / Input / Output
ListProvisionedModelThroughputs
Command API Reference / Input / Output
ListTagsForResource
Command API Reference / Input / Output
PutModelInvocationLoggingConfiguration
Command API Reference / Input / Output
RegisterMarketplaceModelEndpoint
Command API Reference / Input / Output
StopEvaluationJob
Command API Reference / Input / Output
StopModelCustomizationJob
Command API Reference / Input / Output
StopModelInvocationJob
Command API Reference / Input / Output
TagResource
Command API Reference / Input / Output
UntagResource
Command API Reference / Input / Output
UpdateGuardrail
Command API Reference / Input / Output
UpdateMarketplaceModelEndpoint
Command API Reference / Input / Output
UpdateProvisionedModelThroughput
Command API Reference / Input / Output