Interface BedrockAgentRuntimeClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface BedrockAgentRuntimeClient
extends AwsClient

Service client for accessing Agents for Amazon Bedrock Runtime. This can be created using the static builder() method.

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static BedrockAgentRuntimeClientBuilder	builder()	Create a builder that can be used to configure and create a BedrockAgentRuntimeClient.
static BedrockAgentRuntimeClient	create()	Create a BedrockAgentRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateInvocationResponse	createInvocation(Consumer<CreateInvocationRequest.Builder> createInvocationRequest)	Creates a new invocation within a session.
default CreateInvocationResponse	createInvocation(CreateInvocationRequest createInvocationRequest)	Creates a new invocation within a session.
default CreateSessionResponse	createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest)	Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex.
default CreateSessionResponse	createSession(CreateSessionRequest createSessionRequest)	Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex.
default DeleteAgentMemoryResponse	deleteAgentMemory(Consumer<DeleteAgentMemoryRequest.Builder> deleteAgentMemoryRequest)	Deletes memory from the specified memory identifier.
default DeleteAgentMemoryResponse	deleteAgentMemory(DeleteAgentMemoryRequest deleteAgentMemoryRequest)	Deletes memory from the specified memory identifier.
default DeleteSessionResponse	deleteSession(Consumer<DeleteSessionRequest.Builder> deleteSessionRequest)	Deletes a session that you ended.
default DeleteSessionResponse	deleteSession(DeleteSessionRequest deleteSessionRequest)	Deletes a session that you ended.
default EndSessionResponse	endSession(Consumer<EndSessionRequest.Builder> endSessionRequest)	Ends the session.
default EndSessionResponse	endSession(EndSessionRequest endSessionRequest)	Ends the session.
default GenerateQueryResponse	generateQuery(Consumer<GenerateQueryRequest.Builder> generateQueryRequest)	Generates an SQL query from a natural language query.
default GenerateQueryResponse	generateQuery(GenerateQueryRequest generateQueryRequest)	Generates an SQL query from a natural language query.
default GetAgentMemoryResponse	getAgentMemory(Consumer<GetAgentMemoryRequest.Builder> getAgentMemoryRequest)	Gets the sessions stored in the memory of the agent.
default GetAgentMemoryResponse	getAgentMemory(GetAgentMemoryRequest getAgentMemoryRequest)	Gets the sessions stored in the memory of the agent.
default GetAgentMemoryIterable	getAgentMemoryPaginator(Consumer<GetAgentMemoryRequest.Builder> getAgentMemoryRequest)	This is a variant of getAgentMemory(software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryRequest) operation.
default GetAgentMemoryIterable	getAgentMemoryPaginator(GetAgentMemoryRequest getAgentMemoryRequest)	This is a variant of getAgentMemory(software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryRequest) operation.
default GetInvocationStepResponse	getInvocationStep(Consumer<GetInvocationStepRequest.Builder> getInvocationStepRequest)	Retrieves the details of a specific invocation step within an invocation in a session.
default GetInvocationStepResponse	getInvocationStep(GetInvocationStepRequest getInvocationStepRequest)	Retrieves the details of a specific invocation step within an invocation in a session.
default GetSessionResponse	getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)	Retrieves details about a specific session.
default GetSessionResponse	getSession(GetSessionRequest getSessionRequest)	Retrieves details about a specific session.
default ListInvocationsResponse	listInvocations(Consumer<ListInvocationsRequest.Builder> listInvocationsRequest)	Lists all invocations associated with a specific session.
default ListInvocationsResponse	listInvocations(ListInvocationsRequest listInvocationsRequest)	Lists all invocations associated with a specific session.
default ListInvocationsIterable	listInvocationsPaginator(Consumer<ListInvocationsRequest.Builder> listInvocationsRequest)	This is a variant of listInvocations(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsRequest) operation.
default ListInvocationsIterable	listInvocationsPaginator(ListInvocationsRequest listInvocationsRequest)	This is a variant of listInvocations(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsRequest) operation.
default ListInvocationStepsResponse	listInvocationSteps(Consumer<ListInvocationStepsRequest.Builder> listInvocationStepsRequest)	Lists all invocation steps associated with a session and optionally, an invocation within the session.
default ListInvocationStepsResponse	listInvocationSteps(ListInvocationStepsRequest listInvocationStepsRequest)	Lists all invocation steps associated with a session and optionally, an invocation within the session.
default ListInvocationStepsIterable	listInvocationStepsPaginator(Consumer<ListInvocationStepsRequest.Builder> listInvocationStepsRequest)	This is a variant of listInvocationSteps(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsRequest) operation.
default ListInvocationStepsIterable	listInvocationStepsPaginator(ListInvocationStepsRequest listInvocationStepsRequest)	This is a variant of listInvocationSteps(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsRequest) operation.
default ListSessionsResponse	listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)	Lists all sessions in your Amazon Web Services account.
default ListSessionsResponse	listSessions(ListSessionsRequest listSessionsRequest)	Lists all sessions in your Amazon Web Services account.
default ListSessionsIterable	listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)	This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsRequest) operation.
default ListSessionsIterable	listSessionsPaginator(ListSessionsRequest listSessionsRequest)	This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	List all the tags for the resource you specify.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	List all the tags for the resource you specify.
default PutInvocationStepResponse	putInvocationStep(Consumer<PutInvocationStepRequest.Builder> putInvocationStepRequest)	Add an invocation step to an invocation in a session.
default PutInvocationStepResponse	putInvocationStep(PutInvocationStepRequest putInvocationStepRequest)	Add an invocation step to an invocation in a session.
default RerankResponse	rerank(Consumer<RerankRequest.Builder> rerankRequest)	Reranks the relevance of sources based on queries.
default RerankResponse	rerank(RerankRequest rerankRequest)	Reranks the relevance of sources based on queries.
default RerankIterable	rerankPaginator(Consumer<RerankRequest.Builder> rerankRequest)	This is a variant of rerank(software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest) operation.
default RerankIterable	rerankPaginator(RerankRequest rerankRequest)	This is a variant of rerank(software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest) operation.
default RetrieveResponse	retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)	Queries a knowledge base and retrieves information from it.
default RetrieveResponse	retrieve(RetrieveRequest retrieveRequest)	Queries a knowledge base and retrieves information from it.
default RetrieveAndGenerateResponse	retrieveAndGenerate(Consumer<RetrieveAndGenerateRequest.Builder> retrieveAndGenerateRequest)	Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile.
default RetrieveAndGenerateResponse	retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest)	Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile.
default RetrieveIterable	retrievePaginator(Consumer<RetrieveRequest.Builder> retrieveRequest)	This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.
default RetrieveIterable	retrievePaginator(RetrieveRequest retrieveRequest)	This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.
default BedrockAgentRuntimeServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Associate tags with a resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Associate tags with a resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Remove tags from a resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Remove tags from a resource.
default UpdateSessionResponse	updateSession(Consumer<UpdateSessionRequest.Builder> updateSessionRequest)	Updates the metadata or encryption settings of a session.
default UpdateSessionResponse	updateSession(UpdateSessionRequest updateSessionRequest)	Updates the metadata or encryption settings of a session.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createInvocation

default CreateInvocationResponse createInvocation(CreateInvocationRequest createInvocationRequest)
                                           throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Related APIs

• ListInvocations

• ListSessions

• GetSession

Parameters:

createInvocationRequest -

Returns:

Result of the CreateInvocation operation returned by the service.

See Also:

• AWS API Documentation

createInvocation

default CreateInvocationResponse createInvocation(Consumer<CreateInvocationRequest.Builder> createInvocationRequest)
                                           throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Creates a new invocation within a session. An invocation groups the related invocation steps that store the content from a conversation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Related APIs

• ListInvocations

• ListSessions

• GetSession

This is a convenience which creates an instance of the CreateInvocationRequest.Builder avoiding the need to create one manually via CreateInvocationRequest.builder()

Parameters:

createInvocationRequest - A Consumer that will call methods on CreateInvocationRequest.Builder to create a request.

Returns:

Result of the CreateInvocation operation returned by the service.

See Also:

• AWS API Documentation

createSession

default CreateSessionResponse createSession(CreateSessionRequest createSessionRequest)
                                     throws ConflictException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.

You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation.

Related APIs:

• ListSessions

• GetSession

• EndSession

• DeleteSession

Parameters:

createSessionRequest -

Returns:

Result of the CreateSession operation returned by the service.

See Also:

• AWS API Documentation

createSession

default CreateSessionResponse createSession(Consumer<CreateSessionRequest.Builder> createSessionRequest)
                                     throws ConflictException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Creates a session to temporarily store conversations for generative AI (GenAI) applications built with open-source frameworks such as LangGraph and LlamaIndex. Sessions enable you to save the state of conversations at checkpoints, with the added security and infrastructure of Amazon Web Services. For more information, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

By default, Amazon Bedrock uses Amazon Web Services-managed keys for session encryption, including session metadata, or you can use your own KMS key. For more information, see Amazon Bedrock session encryption.

You use a session to store state and conversation history for generative AI applications built with open-source frameworks. For Amazon Bedrock Agents, the service automatically manages conversation context and associates them with the agent-specific sessionId you specify in the InvokeAgent API operation.

Related APIs:

• ListSessions

• GetSession

• EndSession

• DeleteSession

This is a convenience which creates an instance of the CreateSessionRequest.Builder avoiding the need to create one manually via CreateSessionRequest.builder()

Parameters:

createSessionRequest - A Consumer that will call methods on CreateSessionRequest.Builder to create a request.

Returns:

Result of the CreateSession operation returned by the service.

See Also:

• AWS API Documentation

deleteAgentMemory

default DeleteAgentMemoryResponse deleteAgentMemory(DeleteAgentMemoryRequest deleteAgentMemoryRequest)
                                             throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Deletes memory from the specified memory identifier.

Parameters:

deleteAgentMemoryRequest -

Returns:

Result of the DeleteAgentMemory operation returned by the service.

See Also:

• AWS API Documentation

deleteAgentMemory

default DeleteAgentMemoryResponse deleteAgentMemory(Consumer<DeleteAgentMemoryRequest.Builder> deleteAgentMemoryRequest)
                                             throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Deletes memory from the specified memory identifier.

This is a convenience which creates an instance of the DeleteAgentMemoryRequest.Builder avoiding the need to create one manually via DeleteAgentMemoryRequest.builder()

Parameters:

deleteAgentMemoryRequest - A Consumer that will call methods on DeleteAgentMemoryRequest.Builder to create a request.

Returns:

Result of the DeleteAgentMemory operation returned by the service.

See Also:

• AWS API Documentation

deleteSession

default DeleteSessionResponse deleteSession(DeleteSessionRequest deleteSessionRequest)
                                     throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

deleteSessionRequest -

Returns:

Result of the DeleteSession operation returned by the service.

See Also:

• AWS API Documentation

deleteSession

default DeleteSessionResponse deleteSession(Consumer<DeleteSessionRequest.Builder> deleteSessionRequest)
                                     throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the DeleteSessionRequest.Builder avoiding the need to create one manually via DeleteSessionRequest.builder()

Parameters:

deleteSessionRequest - A Consumer that will call methods on DeleteSessionRequest.Builder to create a request.

Returns:

Result of the DeleteSession operation returned by the service.

See Also:

• AWS API Documentation

endSession

default EndSessionResponse endSession(EndSessionRequest endSessionRequest)
                               throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

endSessionRequest -

Returns:

Result of the EndSession operation returned by the service.

See Also:

• AWS API Documentation

endSession

default EndSessionResponse endSession(Consumer<EndSessionRequest.Builder> endSessionRequest)
                               throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Ends the session. After you end a session, you can still access its content but you can’t add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the EndSessionRequest.Builder avoiding the need to create one manually via EndSessionRequest.builder()

Parameters:

endSessionRequest - A Consumer that will call methods on EndSessionRequest.Builder to create a request.

Returns:

Result of the EndSession operation returned by the service.

See Also:

• AWS API Documentation

generateQuery

default GenerateQueryResponse generateQuery(GenerateQueryRequest generateQueryRequest)
                                     throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.

Parameters:

generateQueryRequest -

Returns:

Result of the GenerateQuery operation returned by the service.

See Also:

• AWS API Documentation

generateQuery

default GenerateQueryResponse generateQuery(Consumer<GenerateQueryRequest.Builder> generateQueryRequest)
                                     throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Generates an SQL query from a natural language query. For more information, see Generate a query for structured data in the Amazon Bedrock User Guide.

This is a convenience which creates an instance of the GenerateQueryRequest.Builder avoiding the need to create one manually via GenerateQueryRequest.builder()

Parameters:

generateQueryRequest - A Consumer that will call methods on GenerateQueryRequest.Builder to create a request.

Returns:

Result of the GenerateQuery operation returned by the service.

See Also:

• AWS API Documentation

getAgentMemory

default GetAgentMemoryResponse getAgentMemory(GetAgentMemoryRequest getAgentMemoryRequest)
                                       throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Gets the sessions stored in the memory of the agent.

Parameters:

getAgentMemoryRequest -

Returns:

Result of the GetAgentMemory operation returned by the service.

See Also:

• AWS API Documentation

getAgentMemory

default GetAgentMemoryResponse getAgentMemory(Consumer<GetAgentMemoryRequest.Builder> getAgentMemoryRequest)
                                       throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Gets the sessions stored in the memory of the agent.

This is a convenience which creates an instance of the GetAgentMemoryRequest.Builder avoiding the need to create one manually via GetAgentMemoryRequest.builder()

Parameters:

getAgentMemoryRequest - A Consumer that will call methods on GetAgentMemoryRequest.Builder to create a request.

Returns:

Result of the GetAgentMemory operation returned by the service.

See Also:

• AWS API Documentation

getAgentMemoryPaginator

default GetAgentMemoryIterable getAgentMemoryPaginator(GetAgentMemoryRequest getAgentMemoryRequest)
                                                throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of getAgentMemory(software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.GetAgentMemoryIterable responses = client.getAgentMemoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.GetAgentMemoryIterable responses = client
             .getAgentMemoryPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.GetAgentMemoryIterable responses = client.getAgentMemoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getAgentMemory(software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryRequest) operation.

Parameters:

getAgentMemoryRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getAgentMemoryPaginator

default GetAgentMemoryIterable getAgentMemoryPaginator(Consumer<GetAgentMemoryRequest.Builder> getAgentMemoryRequest)
                                                throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of getAgentMemory(software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.GetAgentMemoryIterable responses = client.getAgentMemoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.GetAgentMemoryIterable responses = client
             .getAgentMemoryPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.GetAgentMemoryIterable responses = client.getAgentMemoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getAgentMemory(software.amazon.awssdk.services.bedrockagentruntime.model.GetAgentMemoryRequest) operation.

This is a convenience which creates an instance of the GetAgentMemoryRequest.Builder avoiding the need to create one manually via GetAgentMemoryRequest.builder()

Parameters:

getAgentMemoryRequest - A Consumer that will call methods on GetAgentMemoryRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

getInvocationStep

default GetInvocationStepResponse getInvocationStep(GetInvocationStepRequest getInvocationStepRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

getInvocationStepRequest -

Returns:

Result of the GetInvocationStep operation returned by the service.

See Also:

• AWS API Documentation

getInvocationStep

default GetInvocationStepResponse getInvocationStep(Consumer<GetInvocationStepRequest.Builder> getInvocationStepRequest)
                                             throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Retrieves the details of a specific invocation step within an invocation in a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the GetInvocationStepRequest.Builder avoiding the need to create one manually via GetInvocationStepRequest.builder()

Parameters:

getInvocationStepRequest - A Consumer that will call methods on GetInvocationStepRequest.Builder to create a request.

Returns:

Result of the GetInvocationStep operation returned by the service.

See Also:

• AWS API Documentation

getSession

default GetSessionResponse getSession(GetSessionRequest getSessionRequest)
                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

getSessionRequest -

Returns:

Result of the GetSession operation returned by the service.

See Also:

• AWS API Documentation

getSession

default GetSessionResponse getSession(Consumer<GetSessionRequest.Builder> getSessionRequest)
                               throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Retrieves details about a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the GetSessionRequest.Builder avoiding the need to create one manually via GetSessionRequest.builder()

Parameters:

getSessionRequest - A Consumer that will call methods on GetSessionRequest.Builder to create a request.

Returns:

Result of the GetSession operation returned by the service.

See Also:

• AWS API Documentation

listInvocationSteps

default ListInvocationStepsResponse listInvocationSteps(ListInvocationStepsRequest listInvocationStepsRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

listInvocationStepsRequest -

Returns:

Result of the ListInvocationSteps operation returned by the service.

See Also:

• AWS API Documentation

listInvocationSteps

default ListInvocationStepsResponse listInvocationSteps(Consumer<ListInvocationStepsRequest.Builder> listInvocationStepsRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Lists all invocation steps associated with a session and optionally, an invocation within the session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the ListInvocationStepsRequest.Builder avoiding the need to create one manually via ListInvocationStepsRequest.builder()

Parameters:

listInvocationStepsRequest - A Consumer that will call methods on ListInvocationStepsRequest.Builder to create a request.

Returns:

Result of the ListInvocationSteps operation returned by the service.

See Also:

• AWS API Documentation

listInvocationStepsPaginator

default ListInvocationStepsIterable listInvocationStepsPaginator(ListInvocationStepsRequest listInvocationStepsRequest)
                                                          throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of listInvocationSteps(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationStepsIterable responses = client.listInvocationStepsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationStepsIterable responses = client
             .listInvocationStepsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationStepsIterable responses = client.listInvocationStepsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInvocationSteps(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsRequest) operation.

Parameters:

listInvocationStepsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInvocationStepsPaginator

default ListInvocationStepsIterable listInvocationStepsPaginator(Consumer<ListInvocationStepsRequest.Builder> listInvocationStepsRequest)
                                                          throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of listInvocationSteps(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationStepsIterable responses = client.listInvocationStepsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationStepsIterable responses = client
             .listInvocationStepsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationStepsIterable responses = client.listInvocationStepsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInvocationSteps(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationStepsRequest) operation.

This is a convenience which creates an instance of the ListInvocationStepsRequest.Builder avoiding the need to create one manually via ListInvocationStepsRequest.builder()

Parameters:

listInvocationStepsRequest - A Consumer that will call methods on ListInvocationStepsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInvocations

default ListInvocationsResponse listInvocations(ListInvocationsRequest listInvocationsRequest)
                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

listInvocationsRequest -

Returns:

Result of the ListInvocations operation returned by the service.

See Also:

• AWS API Documentation

listInvocations

default ListInvocationsResponse listInvocations(Consumer<ListInvocationsRequest.Builder> listInvocationsRequest)
                                         throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Lists all invocations associated with a specific session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the ListInvocationsRequest.Builder avoiding the need to create one manually via ListInvocationsRequest.builder()

Parameters:

listInvocationsRequest - A Consumer that will call methods on ListInvocationsRequest.Builder to create a request.

Returns:

Result of the ListInvocations operation returned by the service.

See Also:

• AWS API Documentation

listInvocationsPaginator

default ListInvocationsIterable listInvocationsPaginator(ListInvocationsRequest listInvocationsRequest)
                                                  throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of listInvocations(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationsIterable responses = client.listInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationsIterable responses = client
             .listInvocationsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationsIterable responses = client.listInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInvocations(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsRequest) operation.

Parameters:

listInvocationsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listInvocationsPaginator

default ListInvocationsIterable listInvocationsPaginator(Consumer<ListInvocationsRequest.Builder> listInvocationsRequest)
                                                  throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of listInvocations(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationsIterable responses = client.listInvocationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationsIterable responses = client
             .listInvocationsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListInvocationsIterable responses = client.listInvocationsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listInvocations(software.amazon.awssdk.services.bedrockagentruntime.model.ListInvocationsRequest) operation.

This is a convenience which creates an instance of the ListInvocationsRequest.Builder avoiding the need to create one manually via ListInvocationsRequest.builder()

Parameters:

listInvocationsRequest - A Consumer that will call methods on ListInvocationsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSessions

default ListSessionsResponse listSessions(ListSessionsRequest listSessionsRequest)
                                   throws ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

listSessionsRequest -

Returns:

Result of the ListSessions operation returned by the service.

See Also:

• AWS API Documentation

listSessions

default ListSessionsResponse listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)
                                   throws ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the ListSessionsRequest.Builder avoiding the need to create one manually via ListSessionsRequest.builder()

Parameters:

listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.

Returns:

Result of the ListSessions operation returned by the service.

See Also:

• AWS API Documentation

listSessionsPaginator

default ListSessionsIterable listSessionsPaginator(ListSessionsRequest listSessionsRequest)
                                            throws ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.ListSessionsIterable responses = client
             .listSessionsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSessions(software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsRequest) operation.

Parameters:

listSessionsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listSessionsPaginator

default ListSessionsIterable listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)
                                            throws ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.ListSessionsIterable responses = client
             .listSessionsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listSessions(software.amazon.awssdk.services.bedrockagentruntime.model.ListSessionsRequest) operation.

This is a convenience which creates an instance of the ListSessionsRequest.Builder avoiding the need to create one manually via ListSessionsRequest.builder()

Parameters:

listSessionsRequest - A Consumer that will call methods on ListSessionsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

List all the tags for the resource you specify.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

List all the tags for the resource you specify.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

putInvocationStep

default PutInvocationStepResponse putInvocationStep(PutInvocationStepRequest putInvocationStepRequest)
                                             throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Related APIs:

• GetInvocationStep

• ListInvocationSteps

• ListInvocations

• ListSessions

Parameters:

putInvocationStepRequest -

Returns:

Result of the PutInvocationStep operation returned by the service.

See Also:

• AWS API Documentation

putInvocationStep

default PutInvocationStepResponse putInvocationStep(Consumer<PutInvocationStepRequest.Builder> putInvocationStepRequest)
                                             throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Add an invocation step to an invocation in a session. An invocation step stores fine-grained state checkpoints, including text and images, for each interaction. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Related APIs:

• GetInvocationStep

• ListInvocationSteps

• ListInvocations

• ListSessions

This is a convenience which creates an instance of the PutInvocationStepRequest.Builder avoiding the need to create one manually via PutInvocationStepRequest.builder()

Parameters:

putInvocationStepRequest - A Consumer that will call methods on PutInvocationStepRequest.Builder to create a request.

Returns:

Result of the PutInvocationStep operation returned by the service.

See Also:

• AWS API Documentation

rerank

default RerankResponse rerank(RerankRequest rerankRequest)
                       throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.

Parameters:

rerankRequest -

Returns:

Result of the Rerank operation returned by the service.

See Also:

• AWS API Documentation

rerank

default RerankResponse rerank(Consumer<RerankRequest.Builder> rerankRequest)
                       throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Reranks the relevance of sources based on queries. For more information, see Improve the relevance of query responses with a reranker model.

This is a convenience which creates an instance of the RerankRequest.Builder avoiding the need to create one manually via RerankRequest.builder()

Parameters:

rerankRequest - A Consumer that will call methods on RerankRequest.Builder to create a request.

Returns:

Result of the Rerank operation returned by the service.

See Also:

• AWS API Documentation

rerankPaginator

default RerankIterable rerankPaginator(RerankRequest rerankRequest)
                                throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of rerank(software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RerankIterable responses = client.rerankPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.RerankIterable responses = client.rerankPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.RerankResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RerankIterable responses = client.rerankPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the rerank(software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest) operation.

Parameters:

rerankRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

rerankPaginator

default RerankIterable rerankPaginator(Consumer<RerankRequest.Builder> rerankRequest)
                                throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of rerank(software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RerankIterable responses = client.rerankPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.RerankIterable responses = client.rerankPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.RerankResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RerankIterable responses = client.rerankPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the rerank(software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest) operation.

This is a convenience which creates an instance of the RerankRequest.Builder avoiding the need to create one manually via RerankRequest.builder()

Parameters:

rerankRequest - A Consumer that will call methods on RerankRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrieve

default RetrieveResponse retrieve(RetrieveRequest retrieveRequest)
                           throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and retrieves information from it.

Parameters:

retrieveRequest -

Returns:

Result of the Retrieve operation returned by the service.

See Also:

• AWS API Documentation

retrieve

default RetrieveResponse retrieve(Consumer<RetrieveRequest.Builder> retrieveRequest)
                           throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and retrieves information from it.

This is a convenience which creates an instance of the RetrieveRequest.Builder avoiding the need to create one manually via RetrieveRequest.builder()

Parameters:

retrieveRequest - A Consumer that will call methods on RetrieveRequest.Builder to create a request.

Returns:

Result of the Retrieve operation returned by the service.

See Also:

• AWS API Documentation

retrievePaginator

default RetrieveIterable retrievePaginator(RetrieveRequest retrieveRequest)
                                    throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.

Parameters:

retrieveRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrievePaginator

default RetrieveIterable retrievePaginator(Consumer<RetrieveRequest.Builder> retrieveRequest)
                                    throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

This is a variant of retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
     for (software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentruntime.paginators.RetrieveIterable responses = client.retrievePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the retrieve(software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveRequest) operation.

This is a convenience which creates an instance of the RetrieveRequest.Builder avoiding the need to create one manually via RetrieveRequest.builder()

Parameters:

retrieveRequest - A Consumer that will call methods on RetrieveRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

retrieveAndGenerate

default RetrieveAndGenerateResponse retrieveAndGenerate(RetrieveAndGenerateRequest retrieveAndGenerateRequest)
                                                 throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.

Parameters:

retrieveAndGenerateRequest -

Returns:

Result of the RetrieveAndGenerate operation returned by the service.

See Also:

• AWS API Documentation

retrieveAndGenerate

default RetrieveAndGenerateResponse retrieveAndGenerate(Consumer<RetrieveAndGenerateRequest.Builder> retrieveAndGenerateRequest)
                                                 throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
DependencyFailedException,
BadGatewayException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or inference profile. The response only cites sources that are relevant to the query.

This is a convenience which creates an instance of the RetrieveAndGenerateRequest.Builder avoiding the need to create one manually via RetrieveAndGenerateRequest.builder()

Parameters:

retrieveAndGenerateRequest - A Consumer that will call methods on RetrieveAndGenerateRequest.Builder to create a request.

Returns:

Result of the RetrieveAndGenerate operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Remove tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Remove tags from a resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateSession

default UpdateSessionResponse updateSession(UpdateSessionRequest updateSessionRequest)
                                     throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

updateSessionRequest -

Returns:

Result of the UpdateSession operation returned by the service.

See Also:

• AWS API Documentation

updateSession

default UpdateSessionResponse updateSession(Consumer<UpdateSessionRequest.Builder> updateSessionRequest)
                                     throws ConflictException,
ResourceNotFoundException,
ValidationException,
InternalServerException,
ThrottlingException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
BedrockAgentRuntimeException

Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

This is a convenience which creates an instance of the UpdateSessionRequest.Builder avoiding the need to create one manually via UpdateSessionRequest.builder()

Parameters:

updateSessionRequest - A Consumer that will call methods on UpdateSessionRequest.Builder to create a request.

Returns:

Result of the UpdateSession operation returned by the service.

See Also:

• AWS API Documentation

create

static BedrockAgentRuntimeClient create()

Create a BedrockAgentRuntimeClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static BedrockAgentRuntimeClientBuilder builder()

Create a builder that can be used to configure and create a BedrockAgentRuntimeClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BedrockAgentRuntimeServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration