com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClient Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.bedrockagentruntime;
import org.w3c.dom.*;
import java.net.*;
import java.util.*;
import javax.annotation.Generated;
import org.apache.commons.logging.*;
import com.amazonaws.*;
import com.amazonaws.annotation.SdkInternalApi;
import com.amazonaws.auth.*;
import com.amazonaws.handlers.*;
import com.amazonaws.http.*;
import com.amazonaws.internal.*;
import com.amazonaws.internal.auth.*;
import com.amazonaws.metrics.*;
import com.amazonaws.regions.*;
import com.amazonaws.transform.*;
import com.amazonaws.util.*;
import com.amazonaws.protocol.json.*;
import com.amazonaws.util.AWSRequestMetrics.Field;
import com.amazonaws.annotation.ThreadSafe;
import com.amazonaws.client.AwsSyncClientParams;
import com.amazonaws.client.builder.AdvancedConfig;
import com.amazonaws.services.bedrockagentruntime.AWSBedrockAgentRuntimeClientBuilder;
import com.amazonaws.AmazonServiceException;
import com.amazonaws.services.bedrockagentruntime.model.*;
import com.amazonaws.services.bedrockagentruntime.model.transform.*;
/**
* 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.
*
*/
@ThreadSafe
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AWSBedrockAgentRuntimeClient extends AmazonWebServiceClient implements AWSBedrockAgentRuntime {
/** Provider for AWS credentials. */
private final AWSCredentialsProvider awsCredentialsProvider;
private static final Log log = LogFactory.getLog(AWSBedrockAgentRuntime.class);
/** Default signing name for the service. */
private static final String DEFAULT_SIGNING_NAME = "bedrock";
/** Client configuration factory providing ClientConfigurations tailored to this client */
protected static final ClientConfigurationFactory configFactory = new ClientConfigurationFactory();
private final AdvancedConfig advancedConfig;
private static final com.amazonaws.protocol.json.SdkJsonProtocolFactory protocolFactory = new com.amazonaws.protocol.json.SdkJsonProtocolFactory(
new JsonClientMetadata()
.withProtocolVersion("1.1")
.withSupportsCbor(false)
.withSupportsIon(false)
.withContentTypeOverride("application/json")
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("AccessDeniedException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.AccessDeniedExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ConflictException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.ConflictExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ResourceNotFoundException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.ResourceNotFoundExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ThrottlingException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.ThrottlingExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ValidationException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.ValidationExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("ServiceQuotaExceededException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.ServiceQuotaExceededExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("DependencyFailedException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.DependencyFailedExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("InternalServerException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.InternalServerExceptionUnmarshaller.getInstance()))
.addErrorMetadata(
new JsonErrorShapeMetadata().withErrorCode("BadGatewayException").withExceptionUnmarshaller(
com.amazonaws.services.bedrockagentruntime.model.transform.BadGatewayExceptionUnmarshaller.getInstance()))
.withBaseServiceExceptionClass(com.amazonaws.services.bedrockagentruntime.model.AWSBedrockAgentRuntimeException.class));
public static AWSBedrockAgentRuntimeClientBuilder builder() {
return AWSBedrockAgentRuntimeClientBuilder.standard();
}
/**
* Constructs a new client to invoke service methods on Agents for Amazon Bedrock Runtime using the specified
* parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AWSBedrockAgentRuntimeClient(AwsSyncClientParams clientParams) {
this(clientParams, false);
}
/**
* Constructs a new client to invoke service methods on Agents for Amazon Bedrock Runtime using the specified
* parameters.
*
*
* All service calls made using this new client object are blocking, and will not return until the service call
* completes.
*
* @param clientParams
* Object providing client parameters.
*/
AWSBedrockAgentRuntimeClient(AwsSyncClientParams clientParams, boolean endpointDiscoveryEnabled) {
super(clientParams);
this.awsCredentialsProvider = clientParams.getCredentialsProvider();
this.advancedConfig = clientParams.getAdvancedConfig();
init();
}
private void init() {
setServiceNameIntern(DEFAULT_SIGNING_NAME);
setEndpointPrefix(ENDPOINT_PREFIX);
// calling this.setEndPoint(...) will also modify the signer accordingly
setEndpoint("bedrock-agent-runtime.us-east-1.amazonaws.com");
HandlerChainFactory chainFactory = new HandlerChainFactory();
requestHandler2s.addAll(chainFactory.newRequestHandlerChain("/com/amazonaws/services/bedrockagentruntime/request.handlers"));
requestHandler2s.addAll(chainFactory.newRequestHandler2Chain("/com/amazonaws/services/bedrockagentruntime/request.handler2s"));
requestHandler2s.addAll(chainFactory.getGlobalHandlers());
}
/**
*
* Deletes memory from the specified memory identifier.
*
*
* @param deleteAgentMemoryRequest
* @return Result of the DeleteAgentMemory operation returned by the service.
* @throws ConflictException
* There was a conflict performing an operation. Resolve the conflict and retry your request.
* @throws ResourceNotFoundException
* The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
* try your request again.
* @throws ValidationException
* Input validation failed. Check your request parameters and retry the request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws DependencyFailedException
* There was an issue with a dependency. Check the resource configurations and retry the request.
* @throws BadGatewayException
* There was an issue with a dependency due to a server issue. Retry your request.
* @throws ThrottlingException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws AccessDeniedException
* The request is denied because of missing access permissions. Check your permissions and retry your
* request.
* @throws ServiceQuotaExceededException
* The number of requests exceeds the service quota. Resubmit your request later.
* @sample AWSBedrockAgentRuntime.DeleteAgentMemory
* @see AWS API Documentation
*/
@Override
public DeleteAgentMemoryResult deleteAgentMemory(DeleteAgentMemoryRequest request) {
request = beforeClientExecution(request);
return executeDeleteAgentMemory(request);
}
@SdkInternalApi
final DeleteAgentMemoryResult executeDeleteAgentMemory(DeleteAgentMemoryRequest deleteAgentMemoryRequest) {
ExecutionContext executionContext = createExecutionContext(deleteAgentMemoryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new DeleteAgentMemoryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(deleteAgentMemoryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Bedrock Agent Runtime");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "DeleteAgentMemory");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new DeleteAgentMemoryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Gets the sessions stored in the memory of the agent.
*
*
* @param getAgentMemoryRequest
* @return Result of the GetAgentMemory operation returned by the service.
* @throws ConflictException
* There was a conflict performing an operation. Resolve the conflict and retry your request.
* @throws ResourceNotFoundException
* The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
* try your request again.
* @throws ValidationException
* Input validation failed. Check your request parameters and retry the request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws DependencyFailedException
* There was an issue with a dependency. Check the resource configurations and retry the request.
* @throws BadGatewayException
* There was an issue with a dependency due to a server issue. Retry your request.
* @throws ThrottlingException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws AccessDeniedException
* The request is denied because of missing access permissions. Check your permissions and retry your
* request.
* @throws ServiceQuotaExceededException
* The number of requests exceeds the service quota. Resubmit your request later.
* @sample AWSBedrockAgentRuntime.GetAgentMemory
* @see AWS API Documentation
*/
@Override
public GetAgentMemoryResult getAgentMemory(GetAgentMemoryRequest request) {
request = beforeClientExecution(request);
return executeGetAgentMemory(request);
}
@SdkInternalApi
final GetAgentMemoryResult executeGetAgentMemory(GetAgentMemoryRequest getAgentMemoryRequest) {
ExecutionContext executionContext = createExecutionContext(getAgentMemoryRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new GetAgentMemoryRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(getAgentMemoryRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Bedrock Agent Runtime");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "GetAgentMemory");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new GetAgentMemoryResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Queries a knowledge base and retrieves information from it.
*
*
* @param retrieveRequest
* @return 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.
* @throws ResourceNotFoundException
* The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
* try your request again.
* @throws ValidationException
* Input validation failed. Check your request parameters and retry the request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws DependencyFailedException
* There was an issue with a dependency. Check the resource configurations and retry the request.
* @throws BadGatewayException
* There was an issue with a dependency due to a server issue. Retry your request.
* @throws ThrottlingException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws AccessDeniedException
* The request is denied because of missing access permissions. Check your permissions and retry your
* request.
* @throws ServiceQuotaExceededException
* The number of requests exceeds the service quota. Resubmit your request later.
* @sample AWSBedrockAgentRuntime.Retrieve
* @see AWS
* API Documentation
*/
@Override
public RetrieveResult retrieve(RetrieveRequest request) {
request = beforeClientExecution(request);
return executeRetrieve(request);
}
@SdkInternalApi
final RetrieveResult executeRetrieve(RetrieveRequest retrieveRequest) {
ExecutionContext executionContext = createExecutionContext(retrieveRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new RetrieveRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(retrieveRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Bedrock Agent Runtime");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "Retrieve");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(new JsonOperationMetadata()
.withPayloadJson(true).withHasStreamingSuccessResponse(false), new RetrieveResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
*
* Queries a knowledge base and generates responses based on the retrieved results. The response only cites sources
* that are relevant to the query.
*
*
* @param retrieveAndGenerateRequest
* @return 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.
* @throws ResourceNotFoundException
* The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
* try your request again.
* @throws ValidationException
* Input validation failed. Check your request parameters and retry the request.
* @throws InternalServerException
* An internal server error occurred. Retry your request.
* @throws DependencyFailedException
* There was an issue with a dependency. Check the resource configurations and retry the request.
* @throws BadGatewayException
* There was an issue with a dependency due to a server issue. Retry your request.
* @throws ThrottlingException
* The number of requests exceeds the limit. Resubmit your request later.
* @throws AccessDeniedException
* The request is denied because of missing access permissions. Check your permissions and retry your
* request.
* @throws ServiceQuotaExceededException
* The number of requests exceeds the service quota. Resubmit your request later.
* @sample AWSBedrockAgentRuntime.RetrieveAndGenerate
* @see AWS API Documentation
*/
@Override
public RetrieveAndGenerateResult retrieveAndGenerate(RetrieveAndGenerateRequest request) {
request = beforeClientExecution(request);
return executeRetrieveAndGenerate(request);
}
@SdkInternalApi
final RetrieveAndGenerateResult executeRetrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest) {
ExecutionContext executionContext = createExecutionContext(retrieveAndGenerateRequest);
AWSRequestMetrics awsRequestMetrics = executionContext.getAwsRequestMetrics();
awsRequestMetrics.startEvent(Field.ClientExecuteTime);
Request request = null;
Response response = null;
try {
awsRequestMetrics.startEvent(Field.RequestMarshallTime);
try {
request = new RetrieveAndGenerateRequestProtocolMarshaller(protocolFactory).marshall(super.beforeMarshalling(retrieveAndGenerateRequest));
// Binds the request metrics to the current request.
request.setAWSRequestMetrics(awsRequestMetrics);
request.addHandlerContext(HandlerContextKey.CLIENT_ENDPOINT, endpoint);
request.addHandlerContext(HandlerContextKey.ENDPOINT_OVERRIDDEN, isEndpointOverridden());
request.addHandlerContext(HandlerContextKey.SIGNING_REGION, getSigningRegion());
request.addHandlerContext(HandlerContextKey.SERVICE_ID, "Bedrock Agent Runtime");
request.addHandlerContext(HandlerContextKey.OPERATION_NAME, "RetrieveAndGenerate");
request.addHandlerContext(HandlerContextKey.ADVANCED_CONFIG, advancedConfig);
} finally {
awsRequestMetrics.endEvent(Field.RequestMarshallTime);
}
HttpResponseHandler> responseHandler = protocolFactory.createResponseHandler(
new JsonOperationMetadata().withPayloadJson(true).withHasStreamingSuccessResponse(false), new RetrieveAndGenerateResultJsonUnmarshaller());
response = invoke(request, responseHandler, executionContext);
return response.getAwsResponse();
} finally {
endClientExecution(awsRequestMetrics, request, response);
}
}
/**
* 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.
*
* @param request
* The originally executed request
*
* @return The response metadata for the specified request, or null if none is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request) {
return client.getResponseMetadataForRequest(request);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext) {
return invoke(request, responseHandler, executionContext, null, null);
}
/**
* Normal invoke with authentication. Credentials are required and may be overriden at the request level.
**/
private Response invoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI cachedEndpoint, URI uriFromEndpointTrait) {
executionContext.setCredentialsProvider(CredentialUtils.getCredentialsProvider(request.getOriginalRequest(), awsCredentialsProvider));
return doInvoke(request, responseHandler, executionContext, cachedEndpoint, uriFromEndpointTrait);
}
/**
* Invoke with no authentication. Credentials are not required and any credentials set on the client or request will
* be ignored for this operation.
**/
private Response anonymousInvoke(Request request,
HttpResponseHandler> responseHandler, ExecutionContext executionContext) {
return doInvoke(request, responseHandler, executionContext, null, null);
}
/**
* Invoke the request using the http client. Assumes credentials (or lack thereof) have been configured in the
* ExecutionContext beforehand.
**/
private Response doInvoke(Request request, HttpResponseHandler> responseHandler,
ExecutionContext executionContext, URI discoveredEndpoint, URI uriFromEndpointTrait) {
if (discoveredEndpoint != null) {
request.setEndpoint(discoveredEndpoint);
request.getOriginalRequest().getRequestClientOptions().appendUserAgent("endpoint-discovery");
} else if (uriFromEndpointTrait != null) {
request.setEndpoint(uriFromEndpointTrait);
} else {
request.setEndpoint(endpoint);
}
request.setTimeOffset(timeOffset);
HttpResponseHandler errorResponseHandler = protocolFactory.createErrorResponseHandler(new JsonErrorResponseMetadata());
return client.execute(request, responseHandler, errorResponseHandler, executionContext);
}
@com.amazonaws.annotation.SdkInternalApi
static com.amazonaws.protocol.json.SdkJsonProtocolFactory getProtocolFactory() {
return protocolFactory;
}
@Override
public void shutdown() {
super.shutdown();
}
}