com.amazonaws.services.bedrockagentruntime

Interface AWSBedrockAgentRuntime

All Known Subinterfaces:

AWSBedrockAgentRuntimeAsync

All Known Implementing Classes:

AbstractAWSBedrockAgentRuntime, AbstractAWSBedrockAgentRuntimeAsync, AWSBedrockAgentRuntimeAsyncClient, AWSBedrockAgentRuntimeClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBedrockAgentRuntime

Interface for accessing Agents for Amazon Bedrock Runtime.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBedrockAgentRuntime instead.

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
DeleteAgentMemoryResult	deleteAgentMemory(DeleteAgentMemoryRequest deleteAgentMemoryRequest) Deletes memory from the specified memory identifier.
GetAgentMemoryResult	getAgentMemory(GetAgentMemoryRequest getAgentMemoryRequest) Gets the sessions stored in the memory of the agent.
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 retrieveRequest) Queries a knowledge base and retrieves information from it.
RetrieveAndGenerateResult	retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest) 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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

deleteAgentMemory

DeleteAgentMemoryResult deleteAgentMemory(DeleteAgentMemoryRequest deleteAgentMemoryRequest)

Deletes memory from the specified memory identifier.

Parameters:

deleteAgentMemoryRequest -

Returns:

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.

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (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

getAgentMemory

GetAgentMemoryResult getAgentMemory(GetAgentMemoryRequest getAgentMemoryRequest)

Gets the sessions stored in the memory of the agent.

Parameters:

getAgentMemoryRequest -

Returns:

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.

ResourceNotFoundException - The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (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

retrieve

RetrieveResult retrieve(RetrieveRequest retrieveRequest)

Queries a knowledge base and retrieves information from it.

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 Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (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

RetrieveAndGenerateResult retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest)

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

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 Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (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

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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