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.

Amazon Bedrock Agent

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
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) Retrieve from knowledge base.
RetrieveAndGenerateResult	retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest) RetrieveAndGenerate API
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

retrieve

RetrieveResult retrieve(RetrieveRequest retrieveRequest)

Retrieve from knowledge base.

Parameters:

retrieveRequest -

Returns:

Result of the Retrieve operation returned by the service.

Throws:

ConflictException - This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

DependencyFailedException - This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

BadGatewayException - This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

retrieveAndGenerate

RetrieveAndGenerateResult retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest)

RetrieveAndGenerate API

Parameters:

retrieveAndGenerateRequest -

Returns:

Result of the RetrieveAndGenerate operation returned by the service.

Throws:

ConflictException - This exception is thrown when there is a conflict performing an operation

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

DependencyFailedException - This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource due to a customer fault (i.e. bad configuration)

BadGatewayException - This exception is thrown when a request fails due to dependency like Lambda, Bedrock, STS resource

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

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.