com.amazonaws.services.bedrockruntime

Class AmazonBedrockRuntimeAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.bedrockruntime.AmazonBedrockRuntimeClient

com.amazonaws.services.bedrockruntime.AmazonBedrockRuntimeAsyncClient

All Implemented Interfaces:

AmazonBedrockRuntime, AmazonBedrockRuntimeAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonBedrockRuntimeAsyncClient
extends AmazonBedrockRuntimeClient
implements AmazonBedrockRuntimeAsync

Client for accessing Amazon Bedrock Runtime asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

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

Field Summary

Fields inherited from class com.amazonaws.services.bedrockruntime.AmazonBedrockRuntimeClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.bedrockruntime.AmazonBedrockRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<ApplyGuardrailResult>	applyGuardrailAsync(ApplyGuardrailRequest request) The action to apply a guardrail.
Future<ApplyGuardrailResult>	applyGuardrailAsync(ApplyGuardrailRequest request, AsyncHandler<ApplyGuardrailRequest,ApplyGuardrailResult> asyncHandler) The action to apply a guardrail.
static AmazonBedrockRuntimeAsyncClientBuilder	asyncBuilder()
Future<ConverseResult>	converseAsync(ConverseRequest request) Sends messages to the specified Amazon Bedrock model.
Future<ConverseResult>	converseAsync(ConverseRequest request, AsyncHandler<ConverseRequest,ConverseResult> asyncHandler) Sends messages to the specified Amazon Bedrock model.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<InvokeModelResult>	invokeModelAsync(InvokeModelRequest request) Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
Future<InvokeModelResult>	invokeModelAsync(InvokeModelRequest request, AsyncHandler<InvokeModelRequest,InvokeModelResult> asyncHandler) Invokes the specified Amazon Bedrock model to run inference using the prompt and inference parameters provided in the request body.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.bedrockruntime.AmazonBedrockRuntimeClient

applyGuardrail, builder, converse, getCachedResponseMetadata, invokeModel

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.bedrockruntime.AmazonBedrockRuntime

applyGuardrail, converse, getCachedResponseMetadata, invokeModel

Method Detail

asyncBuilder

public static AmazonBedrockRuntimeAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

applyGuardrailAsync

public Future<ApplyGuardrailResult> applyGuardrailAsync(ApplyGuardrailRequest request)

Description copied from interface: AmazonBedrockRuntimeAsync

The action to apply a guardrail.

Specified by:

applyGuardrailAsync in interface AmazonBedrockRuntimeAsync

Returns:

A Java Future containing the result of the ApplyGuardrail operation returned by the service.

See Also:

AWS API Documentation

applyGuardrailAsync

public Future<ApplyGuardrailResult> applyGuardrailAsync(ApplyGuardrailRequest request,
                                                        AsyncHandler<ApplyGuardrailRequest,ApplyGuardrailResult> asyncHandler)

Description copied from interface: AmazonBedrockRuntimeAsync

The action to apply a guardrail.

Specified by:

applyGuardrailAsync in interface AmazonBedrockRuntimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the ApplyGuardrail operation returned by the service.

See Also:

AWS API Documentation

converseAsync

public Future<ConverseResult> converseAsync(ConverseRequest request)

Description copied from interface: AmazonBedrockRuntimeAsync

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.

Specified by:

converseAsync in interface AmazonBedrockRuntimeAsync

Returns:

A Java Future containing the result of the Converse operation returned by the service.

See Also:

AWS API Documentation

converseAsync

public Future<ConverseResult> converseAsync(ConverseRequest request,
                                            AsyncHandler<ConverseRequest,ConverseResult> asyncHandler)

Description copied from interface: AmazonBedrockRuntimeAsync

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.

Specified by:

converseAsync in interface AmazonBedrockRuntimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the Converse operation returned by the service.

See Also:

AWS API Documentation

invokeModelAsync

public Future<InvokeModelResult> invokeModelAsync(InvokeModelRequest request)

Description copied from interface: AmazonBedrockRuntimeAsync

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.

Specified by:

invokeModelAsync in interface AmazonBedrockRuntimeAsync

Returns:

A Java Future containing the result of the InvokeModel operation returned by the service.

See Also:

AWS API Documentation

invokeModelAsync

public Future<InvokeModelResult> invokeModelAsync(InvokeModelRequest request,
                                                  AsyncHandler<InvokeModelRequest,InvokeModelResult> asyncHandler)

Description copied from interface: AmazonBedrockRuntimeAsync

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.

Specified by:

invokeModelAsync in interface AmazonBedrockRuntimeAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the InvokeModel operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AmazonBedrockRuntime

Overrides:

shutdown in class AmazonBedrockRuntimeClient