com.amazonaws.services.bedrockagentruntime

Class AWSBedrockAgentRuntimeClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient

All Implemented Interfaces:

AWSBedrockAgentRuntime

Direct Known Subclasses:

AWSBedrockAgentRuntimeAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBedrockAgentRuntimeClient
extends AmazonWebServiceClient
implements AWSBedrockAgentRuntime

Client for accessing Agents for Amazon Bedrock Runtime. All service calls made using this client are blocking, and will not return until the service call completes.

Contains APIs related to model invocation and querying of knowledge bases.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntime

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSBedrockAgentRuntimeClientBuilder	builder()
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.
RetrieveResult	retrieve(RetrieveRequest request) Queries a knowledge base and retrieves information from it.
RetrieveAndGenerateResult	retrieveAndGenerate(RetrieveAndGenerateRequest request) Queries a knowledge base and generates responses based on the retrieved results.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static AWSBedrockAgentRuntimeClientBuilder builder()

retrieve

public RetrieveResult retrieve(RetrieveRequest request)

Queries a knowledge base and retrieves information from it.

Specified by:

retrieve in interface AWSBedrockAgentRuntime

Parameters:

retrieveRequest -

Returns:

Result of the Retrieve operation returned by the service.

Throws:

ConflictException - There was a conflict performing an operation. Resolve the conflict and retry your request.

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

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

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

DependencyFailedException - There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException - There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException - The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

See Also:

AWS API Documentation

retrieveAndGenerate

public RetrieveAndGenerateResult retrieveAndGenerate(RetrieveAndGenerateRequest request)

Queries a knowledge base and generates responses based on the retrieved results. The response cites up to five sources but only selects the ones that are relevant to the query.

The numberOfResults field is currently unsupported for RetrieveAndGenerate. Don't include it in the vectorSearchConfiguration object.

Specified by:

retrieveAndGenerate in interface AWSBedrockAgentRuntime

Parameters:

retrieveAndGenerateRequest -

Returns:

Result of the RetrieveAndGenerate operation returned by the service.

Throws:

ConflictException - There was a conflict performing an operation. Resolve the conflict and retry your request.

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

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

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

DependencyFailedException - There was an issue with a dependency. Check the resource configurations and retry the request.

BadGatewayException - There was an issue with a dependency due to a server issue. Retry your request.

ThrottlingException - The number of requests exceeds the limit. Resubmit your request later.

AccessDeniedException - The request is denied because of missing access permissions. Check your permissions and retry your request.

ServiceQuotaExceededException - The number of requests exceeds the service quota. Resubmit your request later.

See Also:

AWS API Documentation

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSBedrockAgentRuntime

Parameters:

request - The originally executed request

Returns:

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

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSBedrockAgentRuntime

Overrides:

shutdown in class AmazonWebServiceClient