Interface BedrockRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BedrockRuntimeClient
extends AwsClient

Service client for accessing Amazon Bedrock Runtime. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default ApplyGuardrailResponse	applyGuardrail(Consumer<ApplyGuardrailRequest.Builder> applyGuardrailRequest)	The action to apply a guardrail.
default ApplyGuardrailResponse	applyGuardrail(ApplyGuardrailRequest applyGuardrailRequest)	The action to apply a guardrail.
static BedrockRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a BedrockRuntimeClient.
default ConverseResponse	converse(Consumer<ConverseRequest.Builder> converseRequest)	Sends messages to the specified Amazon Bedrock model.
default ConverseResponse	converse(ConverseRequest converseRequest)	Sends messages to the specified Amazon Bedrock model.
static BedrockRuntimeClient	create()	Create a BedrockRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default GetAsyncInvokeResponse	getAsyncInvoke(Consumer<GetAsyncInvokeRequest.Builder> getAsyncInvokeRequest)	Retrieve information about an asynchronous invocation.
default GetAsyncInvokeResponse	getAsyncInvoke(GetAsyncInvokeRequest getAsyncInvokeRequest)	Retrieve information about an asynchronous invocation.
default InvokeModelResponse	invokeModel(Consumer<InvokeModelRequest.Builder> invokeModelRequest)	Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
default InvokeModelResponse	invokeModel(InvokeModelRequest invokeModelRequest)	Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
default ListAsyncInvokesResponse	listAsyncInvokes(Consumer<ListAsyncInvokesRequest.Builder> listAsyncInvokesRequest)	Lists asynchronous invocations.
default ListAsyncInvokesResponse	listAsyncInvokes(ListAsyncInvokesRequest listAsyncInvokesRequest)	Lists asynchronous invocations.
default ListAsyncInvokesIterable	listAsyncInvokesPaginator(Consumer<ListAsyncInvokesRequest.Builder> listAsyncInvokesRequest)	This is a variant of listAsyncInvokes(software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesRequest) operation.
default ListAsyncInvokesIterable	listAsyncInvokesPaginator(ListAsyncInvokesRequest listAsyncInvokesRequest)	This is a variant of listAsyncInvokes(software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesRequest) operation.
default BedrockRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartAsyncInvokeResponse	startAsyncInvoke(Consumer<StartAsyncInvokeRequest.Builder> startAsyncInvokeRequest)	Starts an asynchronous invocation.
default StartAsyncInvokeResponse	startAsyncInvoke(StartAsyncInvokeRequest startAsyncInvokeRequest)	Starts an asynchronous invocation.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

applyGuardrail

default ApplyGuardrailResponse applyGuardrail(ApplyGuardrailRequest applyGuardrailRequest)
                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

The action to apply a guardrail.

For troubleshooting some of the common errors you might encounter when using the ApplyGuardrail API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameters:

applyGuardrailRequest -

Returns:

Result of the ApplyGuardrail operation returned by the service.

See Also:

• AWS API Documentation

applyGuardrail

default ApplyGuardrailResponse applyGuardrail(Consumer<ApplyGuardrailRequest.Builder> applyGuardrailRequest)
                                       throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
ValidationException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

The action to apply a guardrail.

For troubleshooting some of the common errors you might encounter when using the ApplyGuardrail API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

This is a convenience which creates an instance of the ApplyGuardrailRequest.Builder avoiding the need to create one manually via ApplyGuardrailRequest.builder()

Parameters:

applyGuardrailRequest - A Consumer that will call methods on ApplyGuardrailRequest.Builder to create a request.

Returns:

Result of the ApplyGuardrail operation returned by the service.

See Also:

• AWS API Documentation

converse

default ConverseResponse converse(ConverseRequest converseRequest)
                           throws AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ModelTimeoutException,
InternalServerException,
ServiceUnavailableException,
ValidationException,
ModelNotReadyException,
ModelErrorException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

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.

You can submit a prompt by including it in the messages field, specifying the modelId of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.

You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the promptVariables field. You can append more messages to the prompt by using the messages field. If you use a prompt from Prompt management, you can't include the following fields in the request: additionalModelRequestFields, inferenceConfig, system, or toolConfig. Instead, these fields must be defined through Prompt management. For more information, see Use a prompt from Prompt management.

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.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the base inference actions (InvokeModel and InvokeModelWithResponseStream). For more information see Deny access for inference on specific models.

For troubleshooting some of the common errors you might encounter when using the Converse API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameters:

converseRequest -

Returns:

Result of the Converse operation returned by the service.

See Also:

• AWS API Documentation

converse

default ConverseResponse converse(Consumer<ConverseRequest.Builder> converseRequest)
                           throws AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
ModelTimeoutException,
InternalServerException,
ServiceUnavailableException,
ValidationException,
ModelNotReadyException,
ModelErrorException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

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.

You can submit a prompt by including it in the messages field, specifying the modelId of a foundation model or inference profile to run inference on it, and including any other fields that are relevant to your use case.

You can also submit a prompt from Prompt management by specifying the ARN of the prompt version and including a map of variables to values in the promptVariables field. You can append more messages to the prompt by using the messages field. If you use a prompt from Prompt management, you can't include the following fields in the request: additionalModelRequestFields, inferenceConfig, system, or toolConfig. Instead, these fields must be defined through Prompt management. For more information, see Use a prompt from Prompt management.

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.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the base inference actions (InvokeModel and InvokeModelWithResponseStream). For more information see Deny access for inference on specific models.

For troubleshooting some of the common errors you might encounter when using the Converse API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

This is a convenience which creates an instance of the ConverseRequest.Builder avoiding the need to create one manually via ConverseRequest.builder()

Parameters:

converseRequest - A Consumer that will call methods on ConverseRequest.Builder to create a request.

Returns:

Result of the Converse operation returned by the service.

See Also:

• AWS API Documentation

getAsyncInvoke

default GetAsyncInvokeResponse getAsyncInvoke(GetAsyncInvokeRequest getAsyncInvokeRequest)
                                       throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

Retrieve information about an asynchronous invocation.

Parameters:

getAsyncInvokeRequest -

Returns:

Result of the GetAsyncInvoke operation returned by the service.

See Also:

• AWS API Documentation

getAsyncInvoke

default GetAsyncInvokeResponse getAsyncInvoke(Consumer<GetAsyncInvokeRequest.Builder> getAsyncInvokeRequest)
                                       throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

Retrieve information about an asynchronous invocation.

This is a convenience which creates an instance of the GetAsyncInvokeRequest.Builder avoiding the need to create one manually via GetAsyncInvokeRequest.builder()

Parameters:

getAsyncInvokeRequest - A Consumer that will call methods on GetAsyncInvokeRequest.Builder to create a request.

Returns:

Result of the GetAsyncInvoke operation returned by the service.

See Also:

• AWS API Documentation

invokeModel

default InvokeModelResponse invokeModel(InvokeModelRequest invokeModelRequest)
                                 throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ModelTimeoutException,
InternalServerException,
ServiceUnavailableException,
ValidationException,
ServiceQuotaExceededException,
ModelNotReadyException,
ModelErrorException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

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.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.

For troubleshooting some of the common errors you might encounter when using the InvokeModel API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

Parameters:

invokeModelRequest -

Returns:

Result of the InvokeModel operation returned by the service.

See Also:

• AWS API Documentation

invokeModel

default InvokeModelResponse invokeModel(Consumer<InvokeModelRequest.Builder> invokeModelRequest)
                                 throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ModelTimeoutException,
InternalServerException,
ServiceUnavailableException,
ValidationException,
ServiceQuotaExceededException,
ModelNotReadyException,
ModelErrorException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

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.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.

For troubleshooting some of the common errors you might encounter when using the InvokeModel API, see Troubleshooting Amazon Bedrock API Error Codes in the Amazon Bedrock User Guide

This is a convenience which creates an instance of the InvokeModelRequest.Builder avoiding the need to create one manually via InvokeModelRequest.builder()

Parameters:

invokeModelRequest - A Consumer that will call methods on InvokeModelRequest.Builder to create a request.

Returns:

Result of the InvokeModel operation returned by the service.

See Also:

• AWS API Documentation

listAsyncInvokes

default ListAsyncInvokesResponse listAsyncInvokes(ListAsyncInvokesRequest listAsyncInvokesRequest)
                                           throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

Lists asynchronous invocations.

Parameters:

listAsyncInvokesRequest -

Returns:

Result of the ListAsyncInvokes operation returned by the service.

See Also:

• AWS API Documentation

listAsyncInvokes

default ListAsyncInvokesResponse listAsyncInvokes(Consumer<ListAsyncInvokesRequest.Builder> listAsyncInvokesRequest)
                                           throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

Lists asynchronous invocations.

This is a convenience which creates an instance of the ListAsyncInvokesRequest.Builder avoiding the need to create one manually via ListAsyncInvokesRequest.builder()

Parameters:

listAsyncInvokesRequest - A Consumer that will call methods on ListAsyncInvokesRequest.Builder to create a request.

Returns:

Result of the ListAsyncInvokes operation returned by the service.

See Also:

• AWS API Documentation

listAsyncInvokesPaginator

default ListAsyncInvokesIterable listAsyncInvokesPaginator(ListAsyncInvokesRequest listAsyncInvokesRequest)
                                                    throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

This is a variant of listAsyncInvokes(software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockruntime.paginators.ListAsyncInvokesIterable responses = client.listAsyncInvokesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockruntime.paginators.ListAsyncInvokesIterable responses = client
             .listAsyncInvokesPaginator(request);
     for (software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockruntime.paginators.ListAsyncInvokesIterable responses = client.listAsyncInvokesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAsyncInvokes(software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesRequest) operation.

Parameters:

listAsyncInvokesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAsyncInvokesPaginator

default ListAsyncInvokesIterable listAsyncInvokesPaginator(Consumer<ListAsyncInvokesRequest.Builder> listAsyncInvokesRequest)
                                                    throws AccessDeniedException,
ThrottlingException,
InternalServerException,
ValidationException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

This is a variant of listAsyncInvokes(software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockruntime.paginators.ListAsyncInvokesIterable responses = client.listAsyncInvokesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockruntime.paginators.ListAsyncInvokesIterable responses = client
             .listAsyncInvokesPaginator(request);
     for (software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockruntime.paginators.ListAsyncInvokesIterable responses = client.listAsyncInvokesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAsyncInvokes(software.amazon.awssdk.services.bedrockruntime.model.ListAsyncInvokesRequest) operation.

This is a convenience which creates an instance of the ListAsyncInvokesRequest.Builder avoiding the need to create one manually via ListAsyncInvokesRequest.builder()

Parameters:

listAsyncInvokesRequest - A Consumer that will call methods on ListAsyncInvokesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

startAsyncInvoke

default StartAsyncInvokeResponse startAsyncInvoke(StartAsyncInvokeRequest startAsyncInvokeRequest)
                                           throws AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ServiceUnavailableException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

Starts an asynchronous invocation.

This operation requires permission for the bedrock:InvokeModel action.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.

Parameters:

startAsyncInvokeRequest -

Returns:

Result of the StartAsyncInvoke operation returned by the service.

See Also:

• AWS API Documentation

startAsyncInvoke

default StartAsyncInvokeResponse startAsyncInvoke(Consumer<StartAsyncInvokeRequest.Builder> startAsyncInvokeRequest)
                                           throws AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
ServiceUnavailableException,
ValidationException,
ServiceQuotaExceededException,
ConflictException,
AwsServiceException,
SdkClientException,
BedrockRuntimeException

Starts an asynchronous invocation.

This operation requires permission for the bedrock:InvokeModel action.

To deny all inference access to resources that you specify in the modelId field, you need to deny access to the bedrock:InvokeModel and bedrock:InvokeModelWithResponseStream actions. Doing this also denies access to the resource through the Converse API actions (Converse and ConverseStream). For more information see Deny access for inference on specific models.

This is a convenience which creates an instance of the StartAsyncInvokeRequest.Builder avoiding the need to create one manually via StartAsyncInvokeRequest.builder()

Parameters:

startAsyncInvokeRequest - A Consumer that will call methods on StartAsyncInvokeRequest.Builder to create a request.

Returns:

Result of the StartAsyncInvoke operation returned by the service.

See Also:

• AWS API Documentation

create

static BedrockRuntimeClient create()

Create a BedrockRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BedrockRuntimeClientBuilder builder()

Create a builder that can be used to configure and create a BedrockRuntimeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BedrockRuntimeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration