software.amazon.awssdk.services.bedrockruntime

Interface BedrockRuntimeAsyncClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

Describes the API operations for running inference using Bedrock models.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static BedrockRuntimeAsyncClientBuilder	builder() Create a builder that can be used to configure and create a BedrockRuntimeAsyncClient.
static BedrockRuntimeAsyncClient	create() Create a BedrockRuntimeAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<InvokeModelResponse>	invokeModel(Consumer<InvokeModelRequest.Builder> invokeModelRequest) Invokes the specified Bedrock model to run inference using the input provided in the request body.
default CompletableFuture<InvokeModelResponse>	invokeModel(InvokeModelRequest invokeModelRequest) Invokes the specified Bedrock model to run inference using the input provided in the request body.
default CompletableFuture<Void>	invokeModelWithResponseStream(Consumer<InvokeModelWithResponseStreamRequest.Builder> invokeModelWithResponseStreamRequest, InvokeModelWithResponseStreamResponseHandler asyncResponseHandler) Invoke the specified Bedrock model to run inference using the input provided.
default CompletableFuture<Void>	invokeModelWithResponseStream(InvokeModelWithResponseStreamRequest invokeModelWithResponseStreamRequest, InvokeModelWithResponseStreamResponseHandler asyncResponseHandler) Invoke the specified Bedrock model to run inference using the input provided.
default BedrockRuntimeServiceClientConfiguration	serviceClientConfiguration()

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

serviceName

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

close

Field Detail

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 Detail

invokeModel

default CompletableFuture<InvokeModelResponse> invokeModel(InvokeModelRequest invokeModelRequest)

Invokes the specified Bedrock model to run inference using the input provided in the request body. You use InvokeModel to run inference for text models, image models, and embedding models.

For more information, see Run inference in the Bedrock User Guide.

For example requests, see Examples (after the Errors section).

Parameters:

invokeModelRequest -

Returns:

A Java Future containing the result of the InvokeModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 The number of requests exceeds the limit. Resubmit your request later.
• ModelTimeoutException The request took too long to process. Processing time exceeded the model timeout length.
• InternalServerException An internal server error occurred. Retry your request.
• 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 The number of requests exceeds the service quota. Resubmit your request later.
• ModelErrorException The request failed due to an error while processing the model.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• BedrockRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

invokeModel

default CompletableFuture<InvokeModelResponse> invokeModel(Consumer<InvokeModelRequest.Builder> invokeModelRequest)

Invokes the specified Bedrock model to run inference using the input provided in the request body. You use InvokeModel to run inference for text models, image models, and embedding models.

For more information, see Run inference in the Bedrock User Guide.

For example requests, see Examples (after the Errors section).

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:

A Java Future containing the result of the InvokeModel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 The number of requests exceeds the limit. Resubmit your request later.
• ModelTimeoutException The request took too long to process. Processing time exceeded the model timeout length.
• InternalServerException An internal server error occurred. Retry your request.
• 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 The number of requests exceeds the service quota. Resubmit your request later.
• ModelErrorException The request failed due to an error while processing the model.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• BedrockRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

invokeModelWithResponseStream

default CompletableFuture<Void> invokeModelWithResponseStream(InvokeModelWithResponseStreamRequest invokeModelWithResponseStreamRequest,
                                                              InvokeModelWithResponseStreamResponseHandler asyncResponseHandler)

Invoke the specified Bedrock model to run inference using the input provided. Return the response in a stream.

For more information, see Run inference in the Bedrock User Guide.

For an example request and response, see Examples (after the Errors section).

Parameters:

invokeModelWithResponseStreamRequest -

Returns:

A Java Future containing the result of the InvokeModelWithResponseStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 The number of requests exceeds the limit. Resubmit your request later.
• ModelTimeoutException The request took too long to process. Processing time exceeded the model timeout length.
• InternalServerException An internal server error occurred. Retry your request.
• ModelStreamErrorException An error occurred while streaming the response.
• 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 The number of requests exceeds the service quota. Resubmit your request later.
• ModelErrorException The request failed due to an error while processing the model.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• BedrockRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

invokeModelWithResponseStream

default CompletableFuture<Void> invokeModelWithResponseStream(Consumer<InvokeModelWithResponseStreamRequest.Builder> invokeModelWithResponseStreamRequest,
                                                              InvokeModelWithResponseStreamResponseHandler asyncResponseHandler)

Invoke the specified Bedrock model to run inference using the input provided. Return the response in a stream.

For more information, see Run inference in the Bedrock User Guide.

For an example request and response, see Examples (after the Errors section).

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

Parameters:

invokeModelWithResponseStreamRequest - A Consumer that will call methods on InvokeModelWithResponseStreamRequest.Builder to create a request.

Returns:

A Java Future containing the result of the InvokeModelWithResponseStream operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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 The number of requests exceeds the limit. Resubmit your request later.
• ModelTimeoutException The request took too long to process. Processing time exceeded the model timeout length.
• InternalServerException An internal server error occurred. Retry your request.
• ModelStreamErrorException An error occurred while streaming the response.
• 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 The number of requests exceeds the service quota. Resubmit your request later.
• ModelErrorException The request failed due to an error while processing the model.
• SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
• BedrockRuntimeException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

See Also:

AWS API Documentation

serviceClientConfiguration

default BedrockRuntimeServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

create

static BedrockRuntimeAsyncClient create()

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

builder

static BedrockRuntimeAsyncClientBuilder builder()

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