Package software.amazon.awssdk.services.bedrockruntime

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 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 BedrockRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()

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.

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.

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,
ResourceNotFoundException,
ThrottlingException,
ModelTimeoutException,
InternalServerException,
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. Should a model have unique inference parameters, you can also pass those unique parameters to the model.

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.

See Also:

• AWS API Documentation

converse

default ConverseResponse converse(Consumer<ConverseRequest.Builder> converseRequest)
                           throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ModelTimeoutException,
InternalServerException,
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. Should a model have unique inference parameters, you can also pass those unique parameters to the model.

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.

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

invokeModel

default InvokeModelResponse invokeModel(InvokeModelRequest invokeModelRequest)
                                 throws AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
ModelTimeoutException,
InternalServerException,
ValidationException,
ModelNotReadyException,
ServiceQuotaExceededException,
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.

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,
ValidationException,
ModelNotReadyException,
ServiceQuotaExceededException,
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.

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

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