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.
To install this package, use the CLI of your favorite package manager:
npm install @aws-sdk/client-bedrock
yarn add @aws-sdk/client-bedrock
pnpm add @aws-sdk/client-bedrock
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";
To send a request:
- Instantiate a client with configuration (e.g. credentials, region).
- Instantiate a command with input parameters.
- Call the
send operation on the client, providing the command object as input.
const client = new BedrockClient({ region: "REGION" });
const params = { };
const command = new ListCustomModelsCommand(params);
We recommend using the await
operator to wait for the promise returned by send operation as follows:
try {
const data = await client.send(command);
} catch (error) {
} finally {
}
You can also use Promise chaining.
client
.send(command)
.then((data) => {
})
.catch((error) => {
})
.finally(() => {
});
The aggregated client class is exported from the same package, but without the "Client" suffix.
Bedrock extends BedrockClient 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 (BedrockClient).
More details are in the blog post on
modular packages in AWS SDK for JavaScript.
import { Bedrock } from "@aws-sdk/client-bedrock";
const client = new Bedrock({ region: "REGION" });
try {
const data = await client.listCustomModels(params);
} catch (error) {
}
client
.listCustomModels(params)
.then((data) => {
})
.catch((error) => {
});
client.listCustomModels(params, (err, data) => {
});
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 });
}
See also docs/ERROR_HANDLING.
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.
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 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.
BatchDeleteAdvancedPromptOptimizationJob
Command API Reference / Input / Output
BatchDeleteEvaluationJob
Command API Reference / Input / Output
CancelAutomatedReasoningPolicyBuildWorkflow
Command API Reference / Input / Output
CreateAdvancedPromptOptimizationJob
Command API Reference / Input / Output
CreateAutomatedReasoningPolicy
Command API Reference / Input / Output
CreateAutomatedReasoningPolicyTestCase
Command API Reference / Input / Output
CreateAutomatedReasoningPolicyVersion
Command API Reference / Input / Output
CreateCustomModel
Command API Reference / Input / Output
CreateCustomModelDeployment
Command API Reference / Input / Output
CreateEvaluationJob
Command API Reference / Input / Output
CreateFoundationModelAgreement
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
CreatePromptRouter
Command API Reference / Input / Output
CreateProvisionedModelThroughput
Command API Reference / Input / Output
DeleteAutomatedReasoningPolicy
Command API Reference / Input / Output
DeleteAutomatedReasoningPolicyBuildWorkflow
Command API Reference / Input / Output
DeleteAutomatedReasoningPolicyTestCase
Command API Reference / Input / Output
DeleteCustomModel
Command API Reference / Input / Output
DeleteCustomModelDeployment
Command API Reference / Input / Output
DeleteEnforcedGuardrailConfiguration
Command API Reference / Input / Output
DeleteFoundationModelAgreement
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
DeletePromptRouter
Command API Reference / Input / Output
DeleteProvisionedModelThroughput
Command API Reference / Input / Output
DeleteResourcePolicy
Command API Reference / Input / Output
DeregisterMarketplaceModelEndpoint
Command API Reference / Input / Output
ExportAutomatedReasoningPolicyVersion
Command API Reference / Input / Output
GetAccountDataRetention
Command API Reference / Input / Output
GetAdvancedPromptOptimizationJob
Command API Reference / Input / Output
GetAutomatedReasoningPolicy
Command API Reference / Input / Output
GetAutomatedReasoningPolicyAnnotations
Command API Reference / Input / Output
GetAutomatedReasoningPolicyBuildWorkflow
Command API Reference / Input / Output
GetAutomatedReasoningPolicyBuildWorkflowResultAssets
Command API Reference / Input / Output
GetAutomatedReasoningPolicyNextScenario
Command API Reference / Input / Output
GetAutomatedReasoningPolicyTestCase
Command API Reference / Input / Output
GetAutomatedReasoningPolicyTestResult
Command API Reference / Input / Output
GetCustomModel
Command API Reference / Input / Output
GetCustomModelDeployment
Command API Reference / Input / Output
GetEvaluationJob
Command API Reference / Input / Output
GetFoundationModel
Command API Reference / Input / Output
GetFoundationModelAvailability
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
GetResourcePolicy
Command API Reference / Input / Output
GetUseCaseForModelAccess
Command API Reference / Input / Output
ListAdvancedPromptOptimizationJobs
Command API Reference / Input / Output
ListAutomatedReasoningPolicies
Command API Reference / Input / Output
ListAutomatedReasoningPolicyBuildWorkflows
Command API Reference / Input / Output
ListAutomatedReasoningPolicyTestCases
Command API Reference / Input / Output
ListAutomatedReasoningPolicyTestResults
Command API Reference / Input / Output
ListCustomModelDeployments
Command API Reference / Input / Output
ListCustomModels
Command API Reference / Input / Output
ListEnforcedGuardrailsConfiguration
Command API Reference / Input / Output
ListEvaluationJobs
Command API Reference / Input / Output
ListFoundationModelAgreementOffers
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
PutAccountDataRetention
Command API Reference / Input / Output
PutEnforcedGuardrailConfiguration
Command API Reference / Input / Output
PutModelInvocationLoggingConfiguration
Command API Reference / Input / Output
PutResourcePolicy
Command API Reference / Input / Output
PutUseCaseForModelAccess
Command API Reference / Input / Output
RegisterMarketplaceModelEndpoint
Command API Reference / Input / Output
StartAutomatedReasoningPolicyBuildWorkflow
Command API Reference / Input / Output
StartAutomatedReasoningPolicyTestWorkflow
Command API Reference / Input / Output
StopAdvancedPromptOptimizationJob
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
UpdateAutomatedReasoningPolicy
Command API Reference / Input / Output
UpdateAutomatedReasoningPolicyAnnotations
Command API Reference / Input / Output
UpdateAutomatedReasoningPolicyTestCase
Command API Reference / Input / Output
UpdateCustomModelDeployment
Command API Reference / Input / Output
UpdateGuardrail
Command API Reference / Input / Output
UpdateMarketplaceModelEndpoint
Command API Reference / Input / Output
UpdateProvisionedModelThroughput
Command API Reference / Input / Output