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.

Amazon Bedrock Agent

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

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) Retrieve from knowledge base.
RetrieveAndGenerateResult	retrieveAndGenerate(RetrieveAndGenerateRequest request) RetrieveAndGenerate API
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSBedrockAgentRuntimeClientBuilder builder()

retrieve

public RetrieveResult retrieve(RetrieveRequest request)

Retrieve from knowledge base.

Specified by:

retrieve in interface AWSBedrockAgentRuntime

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

public RetrieveAndGenerateResult retrieveAndGenerate(RetrieveAndGenerateRequest request)

RetrieveAndGenerate API

Specified by:

retrieveAndGenerate in interface AWSBedrockAgentRuntime

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

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 interface: AWSBedrockAgentRuntime

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.

Specified by:

shutdown in interface AWSBedrockAgentRuntime

Overrides:

shutdown in class AmazonWebServiceClient