com.amazonaws.services.bedrockruntime

Interface AmazonBedrockRuntime

All Known Subinterfaces:

AmazonBedrockRuntimeAsync

All Known Implementing Classes:

AbstractAmazonBedrockRuntime, AbstractAmazonBedrockRuntimeAsync, AmazonBedrockRuntimeAsyncClient, AmazonBedrockRuntimeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonBedrockRuntime

Interface for accessing Amazon Bedrock Runtime.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonBedrockRuntime instead.

Describes the API operations for running inference using Amazon Bedrock models.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
ApplyGuardrailResult	applyGuardrail(ApplyGuardrailRequest applyGuardrailRequest) The action to apply a guardrail.
ConverseResult	converse(ConverseRequest converseRequest) Sends messages to the specified Amazon Bedrock model.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
InvokeModelResult	invokeModel(InvokeModelRequest invokeModelRequest) Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

applyGuardrail

ApplyGuardrailResult applyGuardrail(ApplyGuardrailRequest applyGuardrailRequest)

The action to apply a guardrail.

Parameters:

applyGuardrailRequest -

Returns:

Result of the ApplyGuardrail operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.

ThrottlingException - Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

InternalServerException - An internal server error occurred. Retry your request.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ServiceQuotaExceededException - Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

See Also:

AWS API Documentation

converse

ConverseResult converse(ConverseRequest converseRequest)

Sends messages to the specified Amazon Bedrock model. Converse provides a consistent interface that works with all models that support messages. This allows you to write code once and use it with different models. If a model has unique inference parameters, you can also pass those unique parameters to the model.

Amazon Bedrock doesn't store any text, images, or documents that you provide as content. The data is only used to generate the response.

For information about the Converse API, see Use the Converse API in the Amazon Bedrock User Guide. To use a guardrail, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide. To use a tool with a model, see Tool use (Function calling) in the Amazon Bedrock User Guide

For example code, see Converse API examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

Parameters:

converseRequest -

Returns:

Result of the Converse operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.

ThrottlingException - Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

ModelTimeoutException - The request took too long to process. Processing time exceeded the model timeout length.

InternalServerException - An internal server error occurred. Retry your request.

ServiceUnavailableException - The service isn't currently available. Try again later.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ModelNotReadyException - The model specified in the request is not ready to serve inference requests.

ModelErrorException - The request failed due to an error while processing the model.

See Also:

AWS API Documentation

invokeModel

InvokeModelResult invokeModel(InvokeModelRequest invokeModelRequest)

Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body. You use model inference to generate text, images, and embeddings.

For example code, see Invoke model code examples in the Amazon Bedrock User Guide.

This operation requires permission for the bedrock:InvokeModel action.

Parameters:

invokeModelRequest -

Returns:

Result of the InvokeModel operation returned by the service.

Throws:

AccessDeniedException - The request is denied because of missing access permissions.

ResourceNotFoundException - The specified resource ARN was not found. Check the ARN and try your request again.

ThrottlingException - Your request was throttled because of service-wide limitations. Resubmit your request later or in a different region. You can also purchase Provisioned Throughput to increase the rate or number of tokens you can process.

ModelTimeoutException - The request took too long to process. Processing time exceeded the model timeout length.

InternalServerException - An internal server error occurred. Retry your request.

ServiceUnavailableException - The service isn't currently available. Try again later.

ValidationException - Input validation failed. Check your request parameters and retry the request.

ModelNotReadyException - The model specified in the request is not ready to serve inference requests.

ServiceQuotaExceededException - Your request exceeds the service quota for your account. You can view your quotas at Viewing service quotas. You can resubmit your request later.

ModelErrorException - The request failed due to an error while processing the model.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.