Package software.amazon.awssdk.services.bedrockagentcore

Interface BedrockAgentCoreClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

Welcome to the Amazon Bedrock AgentCore Data Plane API reference. Data Plane actions process and handle data or workloads within Amazon Web Services services.

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
default BatchCreateMemoryRecordsResponse	batchCreateMemoryRecords(Consumer<BatchCreateMemoryRecordsRequest.Builder> batchCreateMemoryRecordsRequest)	Creates multiple memory records in a single batch operation for the specified memory with custom content.
default BatchCreateMemoryRecordsResponse	batchCreateMemoryRecords(BatchCreateMemoryRecordsRequest batchCreateMemoryRecordsRequest)	Creates multiple memory records in a single batch operation for the specified memory with custom content.
default BatchDeleteMemoryRecordsResponse	batchDeleteMemoryRecords(Consumer<BatchDeleteMemoryRecordsRequest.Builder> batchDeleteMemoryRecordsRequest)	Deletes multiple memory records in a single batch operation from the specified memory.
default BatchDeleteMemoryRecordsResponse	batchDeleteMemoryRecords(BatchDeleteMemoryRecordsRequest batchDeleteMemoryRecordsRequest)	Deletes multiple memory records in a single batch operation from the specified memory.
default BatchUpdateMemoryRecordsResponse	batchUpdateMemoryRecords(Consumer<BatchUpdateMemoryRecordsRequest.Builder> batchUpdateMemoryRecordsRequest)	Updates multiple memory records with custom content in a single batch operation within the specified memory.
default BatchUpdateMemoryRecordsResponse	batchUpdateMemoryRecords(BatchUpdateMemoryRecordsRequest batchUpdateMemoryRecordsRequest)	Updates multiple memory records with custom content in a single batch operation within the specified memory.
static BedrockAgentCoreClientBuilder	builder()	Create a builder that can be used to configure and create a BedrockAgentCoreClient.
default CompleteResourceTokenAuthResponse	completeResourceTokenAuth(Consumer<CompleteResourceTokenAuthRequest.Builder> completeResourceTokenAuthRequest)	Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
default CompleteResourceTokenAuthResponse	completeResourceTokenAuth(CompleteResourceTokenAuthRequest completeResourceTokenAuthRequest)	Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.
static BedrockAgentCoreClient	create()	Create a BedrockAgentCoreClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAbTestResponse	createABTest(Consumer<CreateAbTestRequest.Builder> createAbTestRequest)	Creates an A/B test for comparing agent configurations.
default CreateAbTestResponse	createABTest(CreateAbTestRequest createAbTestRequest)	Creates an A/B test for comparing agent configurations.
default CreateEventResponse	createEvent(Consumer<CreateEventRequest.Builder> createEventRequest)	Creates an event in an AgentCore Memory resource.
default CreateEventResponse	createEvent(CreateEventRequest createEventRequest)	Creates an event in an AgentCore Memory resource.
default CreatePaymentInstrumentResponse	createPaymentInstrument(Consumer<CreatePaymentInstrumentRequest.Builder> createPaymentInstrumentRequest)	Create a new payment instrument for a connector.
default CreatePaymentInstrumentResponse	createPaymentInstrument(CreatePaymentInstrumentRequest createPaymentInstrumentRequest)	Create a new payment instrument for a connector.
default CreatePaymentSessionResponse	createPaymentSession(Consumer<CreatePaymentSessionRequest.Builder> createPaymentSessionRequest)	Create a new payment session.
default CreatePaymentSessionResponse	createPaymentSession(CreatePaymentSessionRequest createPaymentSessionRequest)	Create a new payment session.
default DeleteAbTestResponse	deleteABTest(Consumer<DeleteAbTestRequest.Builder> deleteAbTestRequest)	Deletes an A/B test and its associated gateway rules.
default DeleteAbTestResponse	deleteABTest(DeleteAbTestRequest deleteAbTestRequest)	Deletes an A/B test and its associated gateway rules.
default DeleteBatchEvaluationResponse	deleteBatchEvaluation(Consumer<DeleteBatchEvaluationRequest.Builder> deleteBatchEvaluationRequest)	Deletes a batch evaluation and its associated results.
default DeleteBatchEvaluationResponse	deleteBatchEvaluation(DeleteBatchEvaluationRequest deleteBatchEvaluationRequest)	Deletes a batch evaluation and its associated results.
default DeleteEventResponse	deleteEvent(Consumer<DeleteEventRequest.Builder> deleteEventRequest)	Deletes an event from an AgentCore Memory resource.
default DeleteEventResponse	deleteEvent(DeleteEventRequest deleteEventRequest)	Deletes an event from an AgentCore Memory resource.
default DeleteMemoryRecordResponse	deleteMemoryRecord(Consumer<DeleteMemoryRecordRequest.Builder> deleteMemoryRecordRequest)	Deletes a memory record from an AgentCore Memory resource.
default DeleteMemoryRecordResponse	deleteMemoryRecord(DeleteMemoryRecordRequest deleteMemoryRecordRequest)	Deletes a memory record from an AgentCore Memory resource.
default DeletePaymentInstrumentResponse	deletePaymentInstrument(Consumer<DeletePaymentInstrumentRequest.Builder> deletePaymentInstrumentRequest)	Deletes a payment instrument.
default DeletePaymentInstrumentResponse	deletePaymentInstrument(DeletePaymentInstrumentRequest deletePaymentInstrumentRequest)	Deletes a payment instrument.
default DeletePaymentSessionResponse	deletePaymentSession(Consumer<DeletePaymentSessionRequest.Builder> deletePaymentSessionRequest)	Deletes a payment session.
default DeletePaymentSessionResponse	deletePaymentSession(DeletePaymentSessionRequest deletePaymentSessionRequest)	Deletes a payment session.
default DeleteRecommendationResponse	deleteRecommendation(Consumer<DeleteRecommendationRequest.Builder> deleteRecommendationRequest)	Deletes a recommendation and its associated results.
default DeleteRecommendationResponse	deleteRecommendation(DeleteRecommendationRequest deleteRecommendationRequest)	Deletes a recommendation and its associated results.
default EvaluateResponse	evaluate(Consumer<EvaluateRequest.Builder> evaluateRequest)	Performs on-demand evaluation of agent traces using a specified evaluator.
default EvaluateResponse	evaluate(EvaluateRequest evaluateRequest)	Performs on-demand evaluation of agent traces using a specified evaluator.
default GetAbTestResponse	getABTest(Consumer<GetAbTestRequest.Builder> getAbTestRequest)	Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
default GetAbTestResponse	getABTest(GetAbTestRequest getAbTestRequest)	Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.
default GetAgentCardResponse	getAgentCard(Consumer<GetAgentCardRequest.Builder> getAgentCardRequest)	Retrieves the A2A agent card associated with an AgentCore Runtime agent.
default GetAgentCardResponse	getAgentCard(GetAgentCardRequest getAgentCardRequest)	Retrieves the A2A agent card associated with an AgentCore Runtime agent.
default GetBatchEvaluationResponse	getBatchEvaluation(Consumer<GetBatchEvaluationRequest.Builder> getBatchEvaluationRequest)	Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
default GetBatchEvaluationResponse	getBatchEvaluation(GetBatchEvaluationRequest getBatchEvaluationRequest)	Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.
default GetBrowserSessionResponse	getBrowserSession(Consumer<GetBrowserSessionRequest.Builder> getBrowserSessionRequest)	Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore.
default GetBrowserSessionResponse	getBrowserSession(GetBrowserSessionRequest getBrowserSessionRequest)	Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore.
default GetCodeInterpreterSessionResponse	getCodeInterpreterSession(Consumer<GetCodeInterpreterSessionRequest.Builder> getCodeInterpreterSessionRequest)	Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore.
default GetCodeInterpreterSessionResponse	getCodeInterpreterSession(GetCodeInterpreterSessionRequest getCodeInterpreterSessionRequest)	Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore.
default GetEventResponse	getEvent(Consumer<GetEventRequest.Builder> getEventRequest)	Retrieves information about a specific event in an AgentCore Memory resource.
default GetEventResponse	getEvent(GetEventRequest getEventRequest)	Retrieves information about a specific event in an AgentCore Memory resource.
default GetMemoryRecordResponse	getMemoryRecord(Consumer<GetMemoryRecordRequest.Builder> getMemoryRecordRequest)	Retrieves a specific memory record from an AgentCore Memory resource.
default GetMemoryRecordResponse	getMemoryRecord(GetMemoryRecordRequest getMemoryRecordRequest)	Retrieves a specific memory record from an AgentCore Memory resource.
default GetPaymentInstrumentResponse	getPaymentInstrument(Consumer<GetPaymentInstrumentRequest.Builder> getPaymentInstrumentRequest)	Get a payment instrument by ID.
default GetPaymentInstrumentResponse	getPaymentInstrument(GetPaymentInstrumentRequest getPaymentInstrumentRequest)	Get a payment instrument by ID.
default GetPaymentInstrumentBalanceResponse	getPaymentInstrumentBalance(Consumer<GetPaymentInstrumentBalanceRequest.Builder> getPaymentInstrumentBalanceRequest)	Get the balance of a payment instrument.
default GetPaymentInstrumentBalanceResponse	getPaymentInstrumentBalance(GetPaymentInstrumentBalanceRequest getPaymentInstrumentBalanceRequest)	Get the balance of a payment instrument.
default GetPaymentSessionResponse	getPaymentSession(Consumer<GetPaymentSessionRequest.Builder> getPaymentSessionRequest)	Get a payment session.
default GetPaymentSessionResponse	getPaymentSession(GetPaymentSessionRequest getPaymentSessionRequest)	Get a payment session.
default GetRecommendationResponse	getRecommendation(Consumer<GetRecommendationRequest.Builder> getRecommendationRequest)	Retrieves detailed information about a recommendation, including its configuration, status, and results.
default GetRecommendationResponse	getRecommendation(GetRecommendationRequest getRecommendationRequest)	Retrieves detailed information about a recommendation, including its configuration, status, and results.
default GetResourceApiKeyResponse	getResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest)	Retrieves the API key associated with an API key credential provider.
default GetResourceApiKeyResponse	getResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest)	Retrieves the API key associated with an API key credential provider.
default GetResourceOauth2TokenResponse	getResourceOauth2Token(Consumer<GetResourceOauth2TokenRequest.Builder> getResourceOauth2TokenRequest)	Returns the OAuth 2.0 token of the provided resource.
default GetResourceOauth2TokenResponse	getResourceOauth2Token(GetResourceOauth2TokenRequest getResourceOauth2TokenRequest)	Returns the OAuth 2.0 token of the provided resource.
default GetResourcePaymentTokenResponse	getResourcePaymentToken(Consumer<GetResourcePaymentTokenRequest.Builder> getResourcePaymentTokenRequest)	Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.
default GetResourcePaymentTokenResponse	getResourcePaymentToken(GetResourcePaymentTokenRequest getResourcePaymentTokenRequest)	Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.
default GetWorkloadAccessTokenResponse	getWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest)	Obtains a workload access token for agentic workloads not acting on behalf of a user.
default GetWorkloadAccessTokenResponse	getWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest)	Obtains a workload access token for agentic workloads not acting on behalf of a user.
default GetWorkloadAccessTokenForJwtResponse	getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest)	Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
default GetWorkloadAccessTokenForJwtResponse	getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest)	Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.
default GetWorkloadAccessTokenForUserIdResponse	getWorkloadAccessTokenForUserId(Consumer<GetWorkloadAccessTokenForUserIdRequest.Builder> getWorkloadAccessTokenForUserIdRequest)	Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
default GetWorkloadAccessTokenForUserIdResponse	getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest)	Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.
default ResponseInputStream<InvokeAgentRuntimeResponse>	invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default InvokeAgentRuntimeResponse	invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest, Path destinationPath)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default <ReturnT> ReturnT	invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest, ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ResponseInputStream<InvokeAgentRuntimeResponse>	invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default InvokeAgentRuntimeResponse	invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest, Path destinationPath)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default <ReturnT> ReturnT	invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest, ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ResponseBytes<InvokeAgentRuntimeResponse>	invokeAgentRuntimeAsBytes(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default ResponseBytes<InvokeAgentRuntimeResponse>	invokeAgentRuntimeAsBytes(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)	Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.
default InvokeBrowserResponse	invokeBrowser(Consumer<InvokeBrowserRequest.Builder> invokeBrowserRequest)	Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore.
default InvokeBrowserResponse	invokeBrowser(InvokeBrowserRequest invokeBrowserRequest)	Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore.
default ListAbTestsResponse	listABTests(Consumer<ListAbTestsRequest.Builder> listAbTestsRequest)	Lists all A/B tests in the account.
default ListAbTestsResponse	listABTests(ListAbTestsRequest listAbTestsRequest)	Lists all A/B tests in the account.
default ListABTestsIterable	listABTestsPaginator(Consumer<ListAbTestsRequest.Builder> listAbTestsRequest)	This is a variant of listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) operation.
default ListABTestsIterable	listABTestsPaginator(ListAbTestsRequest listAbTestsRequest)	This is a variant of listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) operation.
default ListActorsResponse	listActors(Consumer<ListActorsRequest.Builder> listActorsRequest)	Lists all actors in an AgentCore Memory resource.
default ListActorsResponse	listActors(ListActorsRequest listActorsRequest)	Lists all actors in an AgentCore Memory resource.
default ListActorsIterable	listActorsPaginator(Consumer<ListActorsRequest.Builder> listActorsRequest)	This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.
default ListActorsIterable	listActorsPaginator(ListActorsRequest listActorsRequest)	This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.
default ListBatchEvaluationsResponse	listBatchEvaluations(Consumer<ListBatchEvaluationsRequest.Builder> listBatchEvaluationsRequest)	Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
default ListBatchEvaluationsResponse	listBatchEvaluations(ListBatchEvaluationsRequest listBatchEvaluationsRequest)	Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.
default ListBatchEvaluationsIterable	listBatchEvaluationsPaginator(Consumer<ListBatchEvaluationsRequest.Builder> listBatchEvaluationsRequest)	This is a variant of listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) operation.
default ListBatchEvaluationsIterable	listBatchEvaluationsPaginator(ListBatchEvaluationsRequest listBatchEvaluationsRequest)	This is a variant of listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) operation.
default ListBrowserSessionsResponse	listBrowserSessions(Consumer<ListBrowserSessionsRequest.Builder> listBrowserSessionsRequest)	Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria.
default ListBrowserSessionsResponse	listBrowserSessions(ListBrowserSessionsRequest listBrowserSessionsRequest)	Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria.
default ListCodeInterpreterSessionsResponse	listCodeInterpreterSessions(Consumer<ListCodeInterpreterSessionsRequest.Builder> listCodeInterpreterSessionsRequest)	Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria.
default ListCodeInterpreterSessionsResponse	listCodeInterpreterSessions(ListCodeInterpreterSessionsRequest listCodeInterpreterSessionsRequest)	Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria.
default ListEventsResponse	listEvents(Consumer<ListEventsRequest.Builder> listEventsRequest)	Lists events in an AgentCore Memory resource based on specified criteria.
default ListEventsResponse	listEvents(ListEventsRequest listEventsRequest)	Lists events in an AgentCore Memory resource based on specified criteria.
default ListEventsIterable	listEventsPaginator(Consumer<ListEventsRequest.Builder> listEventsRequest)	This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.
default ListEventsIterable	listEventsPaginator(ListEventsRequest listEventsRequest)	This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.
default ListMemoryExtractionJobsResponse	listMemoryExtractionJobs(Consumer<ListMemoryExtractionJobsRequest.Builder> listMemoryExtractionJobsRequest)	Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
default ListMemoryExtractionJobsResponse	listMemoryExtractionJobs(ListMemoryExtractionJobsRequest listMemoryExtractionJobsRequest)	Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.
default ListMemoryExtractionJobsIterable	listMemoryExtractionJobsPaginator(Consumer<ListMemoryExtractionJobsRequest.Builder> listMemoryExtractionJobsRequest)	This is a variant of listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) operation.
default ListMemoryExtractionJobsIterable	listMemoryExtractionJobsPaginator(ListMemoryExtractionJobsRequest listMemoryExtractionJobsRequest)	This is a variant of listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) operation.
default ListMemoryRecordsResponse	listMemoryRecords(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)	Lists memory records in an AgentCore Memory resource based on specified criteria.
default ListMemoryRecordsResponse	listMemoryRecords(ListMemoryRecordsRequest listMemoryRecordsRequest)	Lists memory records in an AgentCore Memory resource based on specified criteria.
default ListMemoryRecordsIterable	listMemoryRecordsPaginator(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)	This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.
default ListMemoryRecordsIterable	listMemoryRecordsPaginator(ListMemoryRecordsRequest listMemoryRecordsRequest)	This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.
default ListPaymentInstrumentsResponse	listPaymentInstruments(Consumer<ListPaymentInstrumentsRequest.Builder> listPaymentInstrumentsRequest)	List payment instruments for a manager.
default ListPaymentInstrumentsResponse	listPaymentInstruments(ListPaymentInstrumentsRequest listPaymentInstrumentsRequest)	List payment instruments for a manager.
default ListPaymentInstrumentsIterable	listPaymentInstrumentsPaginator(Consumer<ListPaymentInstrumentsRequest.Builder> listPaymentInstrumentsRequest)	This is a variant of listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) operation.
default ListPaymentInstrumentsIterable	listPaymentInstrumentsPaginator(ListPaymentInstrumentsRequest listPaymentInstrumentsRequest)	This is a variant of listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) operation.
default ListPaymentSessionsResponse	listPaymentSessions(Consumer<ListPaymentSessionsRequest.Builder> listPaymentSessionsRequest)	List payment sessions.
default ListPaymentSessionsResponse	listPaymentSessions(ListPaymentSessionsRequest listPaymentSessionsRequest)	List payment sessions.
default ListPaymentSessionsIterable	listPaymentSessionsPaginator(Consumer<ListPaymentSessionsRequest.Builder> listPaymentSessionsRequest)	This is a variant of listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) operation.
default ListPaymentSessionsIterable	listPaymentSessionsPaginator(ListPaymentSessionsRequest listPaymentSessionsRequest)	This is a variant of listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) operation.
default ListRecommendationsResponse	listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)	Lists all recommendations in the account, with optional filtering by status.
default ListRecommendationsResponse	listRecommendations(ListRecommendationsRequest listRecommendationsRequest)	Lists all recommendations in the account, with optional filtering by status.
default ListRecommendationsIterable	listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)	This is a variant of listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) operation.
default ListRecommendationsIterable	listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest)	This is a variant of listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) operation.
default ListSessionsResponse	listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)	Lists sessions in an AgentCore Memory resource based on specified criteria.
default ListSessionsResponse	listSessions(ListSessionsRequest listSessionsRequest)	Lists sessions in an AgentCore Memory resource based on specified criteria.
default ListSessionsIterable	listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)	This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation.
default ListSessionsIterable	listSessionsPaginator(ListSessionsRequest listSessionsRequest)	This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation.
default ProcessPaymentResponse	processPayment(Consumer<ProcessPaymentRequest.Builder> processPaymentRequest)	Processes a payment using a payment instrument within a payment session.
default ProcessPaymentResponse	processPayment(ProcessPaymentRequest processPaymentRequest)	Processes a payment using a payment instrument within a payment session.
default RetrieveMemoryRecordsResponse	retrieveMemoryRecords(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)	Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.
default RetrieveMemoryRecordsResponse	retrieveMemoryRecords(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)	Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria.
default RetrieveMemoryRecordsIterable	retrieveMemoryRecordsPaginator(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)	This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.
default RetrieveMemoryRecordsIterable	retrieveMemoryRecordsPaginator(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)	This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.
default SaveBrowserSessionProfileResponse	saveBrowserSessionProfile(Consumer<SaveBrowserSessionProfileRequest.Builder> saveBrowserSessionProfileRequest)	Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore.
default SaveBrowserSessionProfileResponse	saveBrowserSessionProfile(SaveBrowserSessionProfileRequest saveBrowserSessionProfileRequest)	Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore.
default SearchRegistryRecordsResponse	searchRegistryRecords(Consumer<SearchRegistryRecordsRequest.Builder> searchRegistryRecordsRequest)	Searches for registry records using semantic, lexical, or hybrid queries.
default SearchRegistryRecordsResponse	searchRegistryRecords(SearchRegistryRecordsRequest searchRegistryRecordsRequest)	Searches for registry records using semantic, lexical, or hybrid queries.
default BedrockAgentCoreServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartBatchEvaluationResponse	startBatchEvaluation(Consumer<StartBatchEvaluationRequest.Builder> startBatchEvaluationRequest)	Starts a batch evaluation job that evaluates agent performance across multiple sessions.
default StartBatchEvaluationResponse	startBatchEvaluation(StartBatchEvaluationRequest startBatchEvaluationRequest)	Starts a batch evaluation job that evaluates agent performance across multiple sessions.
default StartBrowserSessionResponse	startBrowserSession(Consumer<StartBrowserSessionRequest.Builder> startBrowserSessionRequest)	Creates and initializes a browser session in Amazon Bedrock AgentCore.
default StartBrowserSessionResponse	startBrowserSession(StartBrowserSessionRequest startBrowserSessionRequest)	Creates and initializes a browser session in Amazon Bedrock AgentCore.
default StartCodeInterpreterSessionResponse	startCodeInterpreterSession(Consumer<StartCodeInterpreterSessionRequest.Builder> startCodeInterpreterSessionRequest)	Creates and initializes a code interpreter session in Amazon Bedrock AgentCore.
default StartCodeInterpreterSessionResponse	startCodeInterpreterSession(StartCodeInterpreterSessionRequest startCodeInterpreterSessionRequest)	Creates and initializes a code interpreter session in Amazon Bedrock AgentCore.
default StartMemoryExtractionJobResponse	startMemoryExtractionJob(Consumer<StartMemoryExtractionJobRequest.Builder> startMemoryExtractionJobRequest)	Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records.
default StartMemoryExtractionJobResponse	startMemoryExtractionJob(StartMemoryExtractionJobRequest startMemoryExtractionJobRequest)	Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records.
default StartRecommendationResponse	startRecommendation(Consumer<StartRecommendationRequest.Builder> startRecommendationRequest)	Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
default StartRecommendationResponse	startRecommendation(StartRecommendationRequest startRecommendationRequest)	Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.
default StopBatchEvaluationResponse	stopBatchEvaluation(Consumer<StopBatchEvaluationRequest.Builder> stopBatchEvaluationRequest)	Stops a running batch evaluation.
default StopBatchEvaluationResponse	stopBatchEvaluation(StopBatchEvaluationRequest stopBatchEvaluationRequest)	Stops a running batch evaluation.
default StopBrowserSessionResponse	stopBrowserSession(Consumer<StopBrowserSessionRequest.Builder> stopBrowserSessionRequest)	Terminates an active browser session in Amazon Bedrock AgentCore.
default StopBrowserSessionResponse	stopBrowserSession(StopBrowserSessionRequest stopBrowserSessionRequest)	Terminates an active browser session in Amazon Bedrock AgentCore.
default StopCodeInterpreterSessionResponse	stopCodeInterpreterSession(Consumer<StopCodeInterpreterSessionRequest.Builder> stopCodeInterpreterSessionRequest)	Terminates an active code interpreter session in Amazon Bedrock AgentCore.
default StopCodeInterpreterSessionResponse	stopCodeInterpreterSession(StopCodeInterpreterSessionRequest stopCodeInterpreterSessionRequest)	Terminates an active code interpreter session in Amazon Bedrock AgentCore.
default StopRuntimeSessionResponse	stopRuntimeSession(Consumer<StopRuntimeSessionRequest.Builder> stopRuntimeSessionRequest)	Stops a session that is running in an running AgentCore Runtime agent.
default StopRuntimeSessionResponse	stopRuntimeSession(StopRuntimeSessionRequest stopRuntimeSessionRequest)	Stops a session that is running in an running AgentCore Runtime agent.
default UpdateAbTestResponse	updateABTest(Consumer<UpdateAbTestRequest.Builder> updateAbTestRequest)	Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
default UpdateAbTestResponse	updateABTest(UpdateAbTestRequest updateAbTestRequest)	Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.
default UpdateBrowserStreamResponse	updateBrowserStream(Consumer<UpdateBrowserStreamRequest.Builder> updateBrowserStreamRequest)	Updates a browser stream.
default UpdateBrowserStreamResponse	updateBrowserStream(UpdateBrowserStreamRequest updateBrowserStreamRequest)	Updates a browser stream.

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

batchCreateMemoryRecords

default BatchCreateMemoryRecordsResponse batchCreateMemoryRecords(BatchCreateMemoryRecordsRequest batchCreateMemoryRecordsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates multiple memory records in a single batch operation for the specified memory with custom content.

Parameters:

batchCreateMemoryRecordsRequest -

Returns:

Result of the BatchCreateMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

batchCreateMemoryRecords

default BatchCreateMemoryRecordsResponse batchCreateMemoryRecords(Consumer<BatchCreateMemoryRecordsRequest.Builder> batchCreateMemoryRecordsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates multiple memory records in a single batch operation for the specified memory with custom content.

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

Parameters:

batchCreateMemoryRecordsRequest - A Consumer that will call methods on BatchCreateMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the BatchCreateMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

batchDeleteMemoryRecords

default BatchDeleteMemoryRecordsResponse batchDeleteMemoryRecords(BatchDeleteMemoryRecordsRequest batchDeleteMemoryRecordsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes multiple memory records in a single batch operation from the specified memory.

Parameters:

batchDeleteMemoryRecordsRequest -

Returns:

Result of the BatchDeleteMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

batchDeleteMemoryRecords

default BatchDeleteMemoryRecordsResponse batchDeleteMemoryRecords(Consumer<BatchDeleteMemoryRecordsRequest.Builder> batchDeleteMemoryRecordsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes multiple memory records in a single batch operation from the specified memory.

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

Parameters:

batchDeleteMemoryRecordsRequest - A Consumer that will call methods on BatchDeleteMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the BatchDeleteMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

batchUpdateMemoryRecords

default BatchUpdateMemoryRecordsResponse batchUpdateMemoryRecords(BatchUpdateMemoryRecordsRequest batchUpdateMemoryRecordsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates multiple memory records with custom content in a single batch operation within the specified memory.

Parameters:

batchUpdateMemoryRecordsRequest -

Returns:

Result of the BatchUpdateMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

batchUpdateMemoryRecords

default BatchUpdateMemoryRecordsResponse batchUpdateMemoryRecords(Consumer<BatchUpdateMemoryRecordsRequest.Builder> batchUpdateMemoryRecordsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates multiple memory records with custom content in a single batch operation within the specified memory.

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

Parameters:

batchUpdateMemoryRecordsRequest - A Consumer that will call methods on BatchUpdateMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the BatchUpdateMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

completeResourceTokenAuth

default CompleteResourceTokenAuthResponse completeResourceTokenAuth(CompleteResourceTokenAuthRequest completeResourceTokenAuthRequest)
                                                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.

Parameters:

completeResourceTokenAuthRequest -

Returns:

Result of the CompleteResourceTokenAuth operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

completeResourceTokenAuth

default CompleteResourceTokenAuthResponse completeResourceTokenAuth(Consumer<CompleteResourceTokenAuthRequest.Builder> completeResourceTokenAuthRequest)
                                                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.

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

Parameters:

completeResourceTokenAuthRequest - A Consumer that will call methods on CompleteResourceTokenAuthRequest.Builder to create a request.

Returns:

Result of the CompleteResourceTokenAuth operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createABTest

default CreateAbTestResponse createABTest(CreateAbTestRequest createAbTestRequest)
                                   throws ServiceQuotaExceededException,
UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.

Parameters:

createAbTestRequest -

Returns:

Result of the CreateABTest operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createABTest

default CreateAbTestResponse createABTest(Consumer<CreateAbTestRequest.Builder> createAbTestRequest)
                                   throws ServiceQuotaExceededException,
UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates an A/B test for comparing agent configurations. A/B tests split traffic between a control variant and a treatment variant through a gateway, then evaluate performance using online evaluation configurations to determine which variant performs better.

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

Parameters:

createAbTestRequest - A Consumer that will call methods on CreateAbTestRequest.Builder to create a request.

Returns:

Result of the CreateABTest operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createEvent

default CreateEventResponse createEvent(CreateEventRequest createEventRequest)
                                 throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
RetryableConflictException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the bedrock-agentcore:CreateEvent permission.

This operation is subject to request rate limiting.

Parameters:

createEventRequest -

Returns:

Result of the CreateEvent operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createEvent

default CreateEventResponse createEvent(Consumer<CreateEventRequest.Builder> createEventRequest)
                                 throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
RetryableConflictException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates an event in an AgentCore Memory resource. Events represent interactions or activities that occur within a session and are associated with specific actors.

To use this operation, you must have the bedrock-agentcore:CreateEvent permission.

This operation is subject to request rate limiting.

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

Parameters:

createEventRequest - A Consumer that will call methods on CreateEventRequest.Builder to create a request.

Returns:

Result of the CreateEvent operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createPaymentInstrument

default CreatePaymentInstrumentResponse createPaymentInstrument(CreatePaymentInstrumentRequest createPaymentInstrumentRequest)
                                                         throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Create a new payment instrument for a connector.

Parameters:

createPaymentInstrumentRequest - Request structure for creating a payment instrument.

Returns:

Result of the CreatePaymentInstrument operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createPaymentInstrument

default CreatePaymentInstrumentResponse createPaymentInstrument(Consumer<CreatePaymentInstrumentRequest.Builder> createPaymentInstrumentRequest)
                                                         throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Create a new payment instrument for a connector.

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

Parameters:

createPaymentInstrumentRequest - A Consumer that will call methods on CreatePaymentInstrumentRequest.Builder to create a request. Request structure for creating a payment instrument.

Returns:

Result of the CreatePaymentInstrument operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createPaymentSession

default CreatePaymentSessionResponse createPaymentSession(CreatePaymentSessionRequest createPaymentSessionRequest)
                                                   throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Create a new payment session.

Parameters:

createPaymentSessionRequest - Request structure for creating a payment session.

Returns:

Result of the CreatePaymentSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

createPaymentSession

default CreatePaymentSessionResponse createPaymentSession(Consumer<CreatePaymentSessionRequest.Builder> createPaymentSessionRequest)
                                                   throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Create a new payment session.

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

Parameters:

createPaymentSessionRequest - A Consumer that will call methods on CreatePaymentSessionRequest.Builder to create a request. Request structure for creating a payment session.

Returns:

Result of the CreatePaymentSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteABTest

default DeleteAbTestResponse deleteABTest(DeleteAbTestRequest deleteAbTestRequest)
                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes an A/B test and its associated gateway rules.

Parameters:

deleteAbTestRequest -

Returns:

Result of the DeleteABTest operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteABTest

default DeleteAbTestResponse deleteABTest(Consumer<DeleteAbTestRequest.Builder> deleteAbTestRequest)
                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes an A/B test and its associated gateway rules.

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

Parameters:

deleteAbTestRequest - A Consumer that will call methods on DeleteAbTestRequest.Builder to create a request.

Returns:

Result of the DeleteABTest operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteBatchEvaluation

default DeleteBatchEvaluationResponse deleteBatchEvaluation(DeleteBatchEvaluationRequest deleteBatchEvaluationRequest)
                                                     throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a batch evaluation and its associated results.

Parameters:

deleteBatchEvaluationRequest -

Returns:

Result of the DeleteBatchEvaluation operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteBatchEvaluation

default DeleteBatchEvaluationResponse deleteBatchEvaluation(Consumer<DeleteBatchEvaluationRequest.Builder> deleteBatchEvaluationRequest)
                                                     throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a batch evaluation and its associated results.

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

Parameters:

deleteBatchEvaluationRequest - A Consumer that will call methods on DeleteBatchEvaluationRequest.Builder to create a request.

Returns:

Result of the DeleteBatchEvaluation operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteEvent

default DeleteEventResponse deleteEvent(DeleteEventRequest deleteEventRequest)
                                 throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.

Parameters:

deleteEventRequest -

Returns:

Result of the DeleteEvent operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteEvent

default DeleteEventResponse deleteEvent(Consumer<DeleteEventRequest.Builder> deleteEventRequest)
                                 throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes an event from an AgentCore Memory resource. When you delete an event, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteEvent permission.

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

Parameters:

deleteEventRequest - A Consumer that will call methods on DeleteEventRequest.Builder to create a request.

Returns:

Result of the DeleteEvent operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteMemoryRecord

default DeleteMemoryRecordResponse deleteMemoryRecord(DeleteMemoryRecordRequest deleteMemoryRecordRequest)
                                               throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.

Parameters:

deleteMemoryRecordRequest -

Returns:

Result of the DeleteMemoryRecord operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteMemoryRecord

default DeleteMemoryRecordResponse deleteMemoryRecord(Consumer<DeleteMemoryRecordRequest.Builder> deleteMemoryRecordRequest)
                                               throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a memory record from an AgentCore Memory resource. When you delete a memory record, it is permanently removed.

To use this operation, you must have the bedrock-agentcore:DeleteMemoryRecord permission.

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

Parameters:

deleteMemoryRecordRequest - A Consumer that will call methods on DeleteMemoryRecordRequest.Builder to create a request.

Returns:

Result of the DeleteMemoryRecord operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deletePaymentInstrument

default DeletePaymentInstrumentResponse deletePaymentInstrument(DeletePaymentInstrumentRequest deletePaymentInstrumentRequest)
                                                         throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.

Parameters:

deletePaymentInstrumentRequest - Request structure for deleting a payment instrument.

Returns:

Result of the DeletePaymentInstrument operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deletePaymentInstrument

default DeletePaymentInstrumentResponse deletePaymentInstrument(Consumer<DeletePaymentInstrumentRequest.Builder> deletePaymentInstrumentRequest)
                                                         throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a payment instrument. This is a soft delete operation that preserves the record for audit and compliance purposes.

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

Parameters:

deletePaymentInstrumentRequest - A Consumer that will call methods on DeletePaymentInstrumentRequest.Builder to create a request. Request structure for deleting a payment instrument.

Returns:

Result of the DeletePaymentInstrument operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deletePaymentSession

default DeletePaymentSessionResponse deletePaymentSession(DeletePaymentSessionRequest deletePaymentSessionRequest)
                                                   throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a payment session. This permanently removes the payment session record.

Parameters:

deletePaymentSessionRequest - Request structure for deleting a payment session.

Returns:

Result of the DeletePaymentSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deletePaymentSession

default DeletePaymentSessionResponse deletePaymentSession(Consumer<DeletePaymentSessionRequest.Builder> deletePaymentSessionRequest)
                                                   throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a payment session. This permanently removes the payment session record.

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

Parameters:

deletePaymentSessionRequest - A Consumer that will call methods on DeletePaymentSessionRequest.Builder to create a request. Request structure for deleting a payment session.

Returns:

Result of the DeletePaymentSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteRecommendation

default DeleteRecommendationResponse deleteRecommendation(DeleteRecommendationRequest deleteRecommendationRequest)
                                                   throws AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a recommendation and its associated results.

Parameters:

deleteRecommendationRequest -

Returns:

Result of the DeleteRecommendation operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

deleteRecommendation

default DeleteRecommendationResponse deleteRecommendation(Consumer<DeleteRecommendationRequest.Builder> deleteRecommendationRequest)
                                                   throws AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Deletes a recommendation and its associated results.

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

Parameters:

deleteRecommendationRequest - A Consumer that will call methods on DeleteRecommendationRequest.Builder to create a request.

Returns:

Result of the DeleteRecommendation operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

evaluate

default EvaluateResponse evaluate(EvaluateRequest evaluateRequest)
                           throws ServiceQuotaExceededException,
UnauthorizedException,
DuplicateIdException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Performs on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.

Parameters:

evaluateRequest -

Returns:

Result of the Evaluate operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

DuplicateIdException - An exception thrown when attempting to create a resource with an identifier that already exists.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

evaluate

default EvaluateResponse evaluate(Consumer<EvaluateRequest.Builder> evaluateRequest)
                           throws ServiceQuotaExceededException,
UnauthorizedException,
DuplicateIdException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Performs on-demand evaluation of agent traces using a specified evaluator. This synchronous API accepts traces in OpenTelemetry format and returns immediate scoring results with detailed explanations.

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

Parameters:

evaluateRequest - A Consumer that will call methods on EvaluateRequest.Builder to create a request.

Returns:

Result of the Evaluate operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

DuplicateIdException - An exception thrown when attempting to create a resource with an identifier that already exists.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getABTest

default GetAbTestResponse getABTest(GetAbTestRequest getAbTestRequest)
                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.

Parameters:

getAbTestRequest -

Returns:

Result of the GetABTest operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getABTest

default GetAbTestResponse getABTest(Consumer<GetAbTestRequest.Builder> getAbTestRequest)
                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about an A/B test, including its configuration, status, and statistical results.

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

Parameters:

getAbTestRequest - A Consumer that will call methods on GetAbTestRequest.Builder to create a request.

Returns:

Result of the GetABTest operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getAgentCard

default GetAgentCardResponse getAgentCard(GetAgentCardRequest getAgentCardRequest)
                                   throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves the A2A agent card associated with an AgentCore Runtime agent.

Parameters:

getAgentCardRequest -

Returns:

Result of the GetAgentCard operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getAgentCard

default GetAgentCardResponse getAgentCard(Consumer<GetAgentCardRequest.Builder> getAgentCardRequest)
                                   throws ServiceQuotaExceededException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves the A2A agent card associated with an AgentCore Runtime agent.

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

Parameters:

getAgentCardRequest - A Consumer that will call methods on GetAgentCardRequest.Builder to create a request.

Returns:

Result of the GetAgentCard operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getBatchEvaluation

default GetBatchEvaluationResponse getBatchEvaluation(GetBatchEvaluationRequest getBatchEvaluationRequest)
                                               throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

Parameters:

getBatchEvaluationRequest -

Returns:

Result of the GetBatchEvaluation operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getBatchEvaluation

default GetBatchEvaluationResponse getBatchEvaluation(Consumer<GetBatchEvaluationRequest.Builder> getBatchEvaluationRequest)
                                               throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a batch evaluation, including its status, configuration, results, and any error details.

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

Parameters:

getBatchEvaluationRequest - A Consumer that will call methods on GetBatchEvaluationRequest.Builder to create a request.

Returns:

Result of the GetBatchEvaluation operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getBrowserSession

default GetBrowserSessionResponse getBrowserSession(GetBrowserSessionRequest getBrowserSessionRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata.

To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.

The following operations are related to GetBrowserSession:

• StartBrowserSession

• ListBrowserSessions

• StopBrowserSession

Parameters:

getBrowserSessionRequest -

Returns:

Result of the GetBrowserSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getBrowserSession

default GetBrowserSessionResponse getBrowserSession(Consumer<GetBrowserSessionRequest.Builder> getBrowserSessionRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific browser session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, associated streams, and metadata.

To get a browser session, you must specify both the browser identifier and the session ID. The response includes information about the session's viewport configuration, timeout settings, and stream endpoints.

The following operations are related to GetBrowserSession:

• StartBrowserSession

• ListBrowserSessions

• StopBrowserSession

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

Parameters:

getBrowserSessionRequest - A Consumer that will call methods on GetBrowserSessionRequest.Builder to create a request.

Returns:

Result of the GetBrowserSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getCodeInterpreterSession

default GetCodeInterpreterSessionResponse getCodeInterpreterSession(GetCodeInterpreterSessionRequest getCodeInterpreterSessionRequest)
                                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.

To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.

The following operations are related to GetCodeInterpreterSession:

• StartCodeInterpreterSession

• ListCodeInterpreterSessions

• StopCodeInterpreterSession

Parameters:

getCodeInterpreterSessionRequest -

Returns:

Result of the GetCodeInterpreterSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getCodeInterpreterSession

default GetCodeInterpreterSessionResponse getCodeInterpreterSession(Consumer<GetCodeInterpreterSessionRequest.Builder> getCodeInterpreterSessionRequest)
                                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a specific code interpreter session in Amazon Bedrock AgentCore. This operation returns the session's configuration, current status, and metadata.

To get a code interpreter session, you must specify both the code interpreter identifier and the session ID. The response includes information about the session's timeout settings and current status.

The following operations are related to GetCodeInterpreterSession:

• StartCodeInterpreterSession

• ListCodeInterpreterSessions

• StopCodeInterpreterSession

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

Parameters:

getCodeInterpreterSessionRequest - A Consumer that will call methods on GetCodeInterpreterSessionRequest.Builder to create a request.

Returns:

Result of the GetCodeInterpreterSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getEvent

default GetEventResponse getEvent(GetEventRequest getEventRequest)
                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves information about a specific event in an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetEvent permission.

Parameters:

getEventRequest -

Returns:

Result of the GetEvent operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getEvent

default GetEventResponse getEvent(Consumer<GetEventRequest.Builder> getEventRequest)
                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves information about a specific event in an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetEvent permission.

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

Parameters:

getEventRequest - A Consumer that will call methods on GetEventRequest.Builder to create a request.

Returns:

Result of the GetEvent operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getMemoryRecord

default GetMemoryRecordResponse getMemoryRecord(GetMemoryRecordRequest getMemoryRecordRequest)
                                         throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a specific memory record from an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.

Parameters:

getMemoryRecordRequest -

Returns:

Result of the GetMemoryRecord operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getMemoryRecord

default GetMemoryRecordResponse getMemoryRecord(Consumer<GetMemoryRecordRequest.Builder> getMemoryRecordRequest)
                                         throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a specific memory record from an AgentCore Memory resource.

To use this operation, you must have the bedrock-agentcore:GetMemoryRecord permission.

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

Parameters:

getMemoryRecordRequest - A Consumer that will call methods on GetMemoryRecordRequest.Builder to create a request.

Returns:

Result of the GetMemoryRecord operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getPaymentInstrument

default GetPaymentInstrumentResponse getPaymentInstrument(GetPaymentInstrumentRequest getPaymentInstrumentRequest)
                                                   throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Get a payment instrument by ID.

Parameters:

getPaymentInstrumentRequest - Request structure for getting a payment instrument.

Returns:

Result of the GetPaymentInstrument operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getPaymentInstrument

default GetPaymentInstrumentResponse getPaymentInstrument(Consumer<GetPaymentInstrumentRequest.Builder> getPaymentInstrumentRequest)
                                                   throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Get a payment instrument by ID.

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

Parameters:

getPaymentInstrumentRequest - A Consumer that will call methods on GetPaymentInstrumentRequest.Builder to create a request. Request structure for getting a payment instrument.

Returns:

Result of the GetPaymentInstrument operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getPaymentInstrumentBalance

default GetPaymentInstrumentBalanceResponse getPaymentInstrumentBalance(GetPaymentInstrumentBalanceRequest getPaymentInstrumentBalanceRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Get the balance of a payment instrument.

Parameters:

getPaymentInstrumentBalanceRequest - Request structure for getting payment instrument balance.

Returns:

Result of the GetPaymentInstrumentBalance operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getPaymentInstrumentBalance

default GetPaymentInstrumentBalanceResponse getPaymentInstrumentBalance(Consumer<GetPaymentInstrumentBalanceRequest.Builder> getPaymentInstrumentBalanceRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Get the balance of a payment instrument.

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

Parameters:

getPaymentInstrumentBalanceRequest - A Consumer that will call methods on GetPaymentInstrumentBalanceRequest.Builder to create a request. Request structure for getting payment instrument balance.

Returns:

Result of the GetPaymentInstrumentBalance operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getPaymentSession

default GetPaymentSessionResponse getPaymentSession(GetPaymentSessionRequest getPaymentSessionRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Get a payment session.

Parameters:

getPaymentSessionRequest - Request structure for getting a payment session.

Returns:

Result of the GetPaymentSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getPaymentSession

default GetPaymentSessionResponse getPaymentSession(Consumer<GetPaymentSessionRequest.Builder> getPaymentSessionRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Get a payment session.

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

Parameters:

getPaymentSessionRequest - A Consumer that will call methods on GetPaymentSessionRequest.Builder to create a request. Request structure for getting a payment session.

Returns:

Result of the GetPaymentSession operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getRecommendation

default GetRecommendationResponse getRecommendation(GetRecommendationRequest getRecommendationRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a recommendation, including its configuration, status, and results.

Parameters:

getRecommendationRequest -

Returns:

Result of the GetRecommendation operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getRecommendation

default GetRecommendationResponse getRecommendation(Consumer<GetRecommendationRequest.Builder> getRecommendationRequest)
                                             throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves detailed information about a recommendation, including its configuration, status, and results.

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

Parameters:

getRecommendationRequest - A Consumer that will call methods on GetRecommendationRequest.Builder to create a request.

Returns:

Result of the GetRecommendation operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getResourceApiKey

default GetResourceApiKeyResponse getResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest)
                                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves the API key associated with an API key credential provider.

Parameters:

getResourceApiKeyRequest -

Returns:

Result of the GetResourceApiKey operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getResourceApiKey

default GetResourceApiKeyResponse getResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest)
                                             throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves the API key associated with an API key credential provider.

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

Parameters:

getResourceApiKeyRequest - A Consumer that will call methods on GetResourceApiKeyRequest.Builder to create a request.

Returns:

Result of the GetResourceApiKey operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getResourceOauth2Token

default GetResourceOauth2TokenResponse getResourceOauth2Token(GetResourceOauth2TokenRequest getResourceOauth2TokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Returns the OAuth 2.0 token of the provided resource.

Parameters:

getResourceOauth2TokenRequest -

Returns:

Result of the GetResourceOauth2Token operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getResourceOauth2Token

default GetResourceOauth2TokenResponse getResourceOauth2Token(Consumer<GetResourceOauth2TokenRequest.Builder> getResourceOauth2TokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Returns the OAuth 2.0 token of the provided resource.

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

Parameters:

getResourceOauth2TokenRequest - A Consumer that will call methods on GetResourceOauth2TokenRequest.Builder to create a request.

Returns:

Result of the GetResourceOauth2Token operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getResourcePaymentToken

default GetResourcePaymentTokenResponse getResourcePaymentToken(GetResourcePaymentTokenRequest getResourcePaymentTokenRequest)
                                                         throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

Parameters:

getResourcePaymentTokenRequest -

Returns:

Result of the GetResourcePaymentToken operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getResourcePaymentToken

default GetResourcePaymentTokenResponse getResourcePaymentToken(Consumer<GetResourcePaymentTokenRequest.Builder> getResourcePaymentTokenRequest)
                                                         throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Generates authentication tokens for payment providers that use vendor-specific authentication mechanisms.

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

Parameters:

getResourcePaymentTokenRequest - A Consumer that will call methods on GetResourcePaymentTokenRequest.Builder to create a request.

Returns:

Result of the GetResourcePaymentToken operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getWorkloadAccessToken

default GetWorkloadAccessTokenResponse getWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains a workload access token for agentic workloads not acting on behalf of a user.

Parameters:

getWorkloadAccessTokenRequest -

Returns:

Result of the GetWorkloadAccessToken operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getWorkloadAccessToken

default GetWorkloadAccessTokenResponse getWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest)
                                                       throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains a workload access token for agentic workloads not acting on behalf of a user.

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

Parameters:

getWorkloadAccessTokenRequest - A Consumer that will call methods on GetWorkloadAccessTokenRequest.Builder to create a request.

Returns:

Result of the GetWorkloadAccessToken operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getWorkloadAccessTokenForJWT

default GetWorkloadAccessTokenForJwtResponse getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest)
                                                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.

Parameters:

getWorkloadAccessTokenForJwtRequest -

Returns:

Result of the GetWorkloadAccessTokenForJWT operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getWorkloadAccessTokenForJWT

default GetWorkloadAccessTokenForJwtResponse getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest)
                                                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains a workload access token for agentic workloads acting on behalf of a user, using a JWT token.

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

Parameters:

getWorkloadAccessTokenForJwtRequest - A Consumer that will call methods on GetWorkloadAccessTokenForJwtRequest.Builder to create a request.

Returns:

Result of the GetWorkloadAccessTokenForJWT operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getWorkloadAccessTokenForUserId

default GetWorkloadAccessTokenForUserIdResponse getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest)
                                                                         throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.

Parameters:

getWorkloadAccessTokenForUserIdRequest -

Returns:

Result of the GetWorkloadAccessTokenForUserId operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

getWorkloadAccessTokenForUserId

default GetWorkloadAccessTokenForUserIdResponse getWorkloadAccessTokenForUserId(Consumer<GetWorkloadAccessTokenForUserIdRequest.Builder> getWorkloadAccessTokenForUserIdRequest)
                                                                         throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Obtains a workload access token for agentic workloads acting on behalf of a user, using the user's ID.

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

Parameters:

getWorkloadAccessTokenForUserIdRequest - A Consumer that will call methods on GetWorkloadAccessTokenForUserIdRequest.Builder to create a request.

Returns:

Result of the GetWorkloadAccessTokenForUserId operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

invokeAgentRuntime

default <ReturnT> ReturnT invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest,
 ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)
                                      throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

Parameters:

invokeAgentRuntimeRequest -

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled InvokeAgentRuntimeResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

invokeAgentRuntime

default <ReturnT> ReturnT invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest,
 ResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> responseTransformer)
                                      throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

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

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

responseTransformer - Functional interface for processing the streamed response content. The unmarshalled InvokeAgentRuntimeResponse and an InputStream to the response content are provided as parameters to the callback. The callback may return a transformed type which will be the return value of this method. See ResponseTransformer for details on implementing this interface and for links to pre-canned implementations for common scenarios like downloading to a file. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

invokeAgentRuntime

default InvokeAgentRuntimeResponse invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest,
 Path destinationPath)
                                               throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

Parameters:

invokeAgentRuntimeRequest -

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• invokeAgentRuntime(InvokeAgentRuntimeRequest, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntime

default InvokeAgentRuntimeResponse invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest,
 Path destinationPath)
                                               throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

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

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

destinationPath - Path to file that response contents will be written to. The file must not exist or this method will throw an exception. If the file is not writable by the current user then an exception will be thrown. The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Returns:

The transformed result of the ResponseTransformer.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• invokeAgentRuntime(InvokeAgentRuntimeRequest, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntime

default ResponseInputStream<InvokeAgentRuntimeResponse> invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)
                                                                    throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

Parameters:

invokeAgentRuntimeRequest -

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• #getObject(invokeAgentRuntime, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntime

default ResponseInputStream<InvokeAgentRuntimeResponse> invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)
                                                                    throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

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

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

Returns:

A ResponseInputStream containing data streamed from service. Note that this is an unmanaged reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior and exhausting connections in the connection pool. The unmarshalled response object can be obtained via ResponseInputStream.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• #getObject(invokeAgentRuntime, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntimeAsBytes

default ResponseBytes<InvokeAgentRuntimeResponse> invokeAgentRuntimeAsBytes(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest)
                                                                     throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

Parameters:

invokeAgentRuntimeRequest -

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• #getObject(invokeAgentRuntime, ResponseTransformer)
• AWS API Documentation

invokeAgentRuntimeAsBytes

default ResponseBytes<InvokeAgentRuntimeResponse> invokeAgentRuntimeAsBytes(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest)
                                                                     throws ServiceQuotaExceededException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Sends a request to an agent or tool hosted in an Amazon Bedrock AgentCore Runtime and receives responses in real-time.

To invoke an agent, you can specify either the AgentCore Runtime ARN or the agent ID with an account ID, and provide a payload containing your request. When you use the agent ID instead of the full ARN, you don't need to URL-encode the identifier. You can optionally specify a qualifier to target a specific endpoint of the agent.

This operation supports streaming responses, allowing you to receive partial responses as they become available. We recommend using pagination to ensure that the operation returns quickly and successfully when processing large responses.

For example code, see Invoke an AgentCore Runtime agent.

If you're integrating your agent with OAuth, you can't use the Amazon Web Services SDK to call InvokeAgentRuntime. Instead, make a HTTPS request to InvokeAgentRuntime. For an example, see Authenticate and authorize with Inbound Auth and Outbound Auth.

To use this operation, you must have the bedrock-agentcore:InvokeAgentRuntime permission. If you are making a call to InvokeAgentRuntime on behalf of a user ID with the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header, You require permissions to both actions ( bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser).

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

Parameters:

invokeAgentRuntimeRequest - A Consumer that will call methods on InvokeAgentRuntimeRequest.Builder to create a request.

Returns:

A ResponseBytes that loads the data streamed from the service into memory and exposes it in convenient in-memory representations like a byte buffer or string. The unmarshalled response object can be obtained via ResponseBytes.response(). The service documentation for the response content is as follows '

The response data from the agent runtime. The format of this data depends on the specific agent configuration and the requested accept type. For most agents, this is a JSON object containing the agent's response to the user's request.

'.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• #getObject(invokeAgentRuntime, ResponseTransformer)
• AWS API Documentation

invokeBrowser

default InvokeBrowserResponse invokeBrowser(InvokeBrowserRequest invokeBrowserRequest)
                                     throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.

You send a request with exactly one action in the BrowserAction union, and receive a corresponding result in the BrowserActionResult union.

The following operations are related to InvokeBrowser:

• StartBrowserSession

• GetBrowserSession

• StopBrowserSession

Parameters:

invokeBrowserRequest - Request for the InvokeBrowser operation.

Returns:

Result of the InvokeBrowser operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

invokeBrowser

default InvokeBrowserResponse invokeBrowser(Consumer<InvokeBrowserRequest.Builder> invokeBrowserRequest)
                                     throws ServiceQuotaExceededException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Invokes an operating system-level action on a browser session in Amazon Bedrock AgentCore. This operation provides direct OS-level control over browser sessions, enabling mouse actions, keyboard input, and screenshots that the WebSocket-based Chrome DevTools Protocol (CDP) cannot handle — such as interacting with print dialogs, context menus, and JavaScript alerts.

You send a request with exactly one action in the BrowserAction union, and receive a corresponding result in the BrowserActionResult union.

The following operations are related to InvokeBrowser:

• StartBrowserSession

• GetBrowserSession

• StopBrowserSession

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

Parameters:

invokeBrowserRequest - A Consumer that will call methods on InvokeBrowserRequest.Builder to create a request. Request for the InvokeBrowser operation.

Returns:

Result of the InvokeBrowser operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listABTests

default ListAbTestsResponse listABTests(ListAbTestsRequest listAbTestsRequest)
                                 throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all A/B tests in the account.

Parameters:

listAbTestsRequest -

Returns:

Result of the ListABTests operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listABTests

default ListAbTestsResponse listABTests(Consumer<ListAbTestsRequest.Builder> listAbTestsRequest)
                                 throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all A/B tests in the account.

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

Parameters:

listAbTestsRequest - A Consumer that will call methods on ListAbTestsRequest.Builder to create a request.

Returns:

Result of the ListABTests operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listABTestsPaginator

default ListABTestsIterable listABTestsPaginator(ListAbTestsRequest listAbTestsRequest)
                                          throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) 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.bedrockagentcore.paginators.ListABTestsIterable responses = client.listABTestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsIterable responses = client
             .listABTestsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsIterable responses = client.listABTestsPaginator(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 listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) operation.

Parameters:

listAbTestsRequest -

Returns:

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

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listABTestsPaginator

default ListABTestsIterable listABTestsPaginator(Consumer<ListAbTestsRequest.Builder> listAbTestsRequest)
                                          throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) 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.bedrockagentcore.paginators.ListABTestsIterable responses = client.listABTestsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsIterable responses = client
             .listABTestsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsIterable responses = client.listABTestsPaginator(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 listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) operation.

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

Parameters:

listAbTestsRequest - A Consumer that will call methods on ListAbTestsRequest.Builder to create a request.

Returns:

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

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listActors

default ListActorsResponse listActors(ListActorsRequest listActorsRequest)
                               throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListActors permission.

Parameters:

listActorsRequest -

Returns:

Result of the ListActors operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listActors

default ListActorsResponse listActors(Consumer<ListActorsRequest.Builder> listActorsRequest)
                               throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all actors in an AgentCore Memory resource. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListActors permission.

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

Parameters:

listActorsRequest - A Consumer that will call methods on ListActorsRequest.Builder to create a request.

Returns:

Result of the ListActors operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listActorsPaginator

default ListActorsIterable listActorsPaginator(ListActorsRequest listActorsRequest)
                                        throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) 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.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client
             .listActorsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(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 listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.

Parameters:

listActorsRequest -

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listActorsPaginator

default ListActorsIterable listActorsPaginator(Consumer<ListActorsRequest.Builder> listActorsRequest)
                                        throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) 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.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client
             .listActorsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsIterable responses = client.listActorsPaginator(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 listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation.

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

Parameters:

listActorsRequest - A Consumer that will call methods on ListActorsRequest.Builder to create a request.

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listBatchEvaluations

default ListBatchEvaluationsResponse listBatchEvaluations(ListBatchEvaluationsRequest listBatchEvaluationsRequest)
                                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.

Parameters:

listBatchEvaluationsRequest -

Returns:

Result of the ListBatchEvaluations operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listBatchEvaluations

default ListBatchEvaluationsResponse listBatchEvaluations(Consumer<ListBatchEvaluationsRequest.Builder> listBatchEvaluationsRequest)
                                                   throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.

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

Parameters:

listBatchEvaluationsRequest - A Consumer that will call methods on ListBatchEvaluationsRequest.Builder to create a request.

Returns:

Result of the ListBatchEvaluations operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listBatchEvaluationsPaginator

default ListBatchEvaluationsIterable listBatchEvaluationsPaginator(ListBatchEvaluationsRequest listBatchEvaluationsRequest)
                                                            throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) 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.bedrockagentcore.paginators.ListBatchEvaluationsIterable responses = client.listBatchEvaluationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsIterable responses = client
             .listBatchEvaluationsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsIterable responses = client.listBatchEvaluationsPaginator(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 listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) operation.

Parameters:

listBatchEvaluationsRequest -

Returns:

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

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listBatchEvaluationsPaginator

default ListBatchEvaluationsIterable listBatchEvaluationsPaginator(Consumer<ListBatchEvaluationsRequest.Builder> listBatchEvaluationsRequest)
                                                            throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) 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.bedrockagentcore.paginators.ListBatchEvaluationsIterable responses = client.listBatchEvaluationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsIterable responses = client
             .listBatchEvaluationsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsIterable responses = client.listBatchEvaluationsPaginator(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 listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) operation.

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

Parameters:

listBatchEvaluationsRequest - A Consumer that will call methods on ListBatchEvaluationsRequest.Builder to create a request.

Returns:

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

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listBrowserSessions

default ListBrowserSessionsResponse listBrowserSessions(ListBrowserSessionsRequest listBrowserSessionsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListBrowserSessions:

• StartBrowserSession

• GetBrowserSession

Parameters:

listBrowserSessionsRequest -

Returns:

Result of the ListBrowserSessions operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listBrowserSessions

default ListBrowserSessionsResponse listBrowserSessions(Consumer<ListBrowserSessionsRequest.Builder> listBrowserSessionsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of browser sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by browser identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListBrowserSessions:

• StartBrowserSession

• GetBrowserSession

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

Parameters:

listBrowserSessionsRequest - A Consumer that will call methods on ListBrowserSessionsRequest.Builder to create a request.

Returns:

Result of the ListBrowserSessions operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listCodeInterpreterSessions

default ListCodeInterpreterSessionsResponse listCodeInterpreterSessions(ListCodeInterpreterSessionsRequest listCodeInterpreterSessionsRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListCodeInterpreterSessions:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameters:

listCodeInterpreterSessionsRequest -

Returns:

Result of the ListCodeInterpreterSessions operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listCodeInterpreterSessions

default ListCodeInterpreterSessionsResponse listCodeInterpreterSessions(Consumer<ListCodeInterpreterSessionsRequest.Builder> listCodeInterpreterSessionsRequest)
                                                                 throws AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Retrieves a list of code interpreter sessions in Amazon Bedrock AgentCore that match the specified criteria. This operation returns summary information about each session, including identifiers, status, and timestamps.

You can filter the results by code interpreter identifier and session status. The operation supports pagination to handle large result sets efficiently.

We recommend using pagination to ensure that the operation returns quickly and successfully when retrieving large numbers of sessions.

The following operations are related to ListCodeInterpreterSessions:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

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

Parameters:

listCodeInterpreterSessionsRequest - A Consumer that will call methods on ListCodeInterpreterSessionsRequest.Builder to create a request.

Returns:

Result of the ListCodeInterpreterSessions operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listEvents

default ListEventsResponse listEvents(ListEventsRequest listEventsRequest)
                               throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListEvents permission.

Parameters:

listEventsRequest -

Returns:

Result of the ListEvents operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listEvents

default ListEventsResponse listEvents(Consumer<ListEventsRequest.Builder> listEventsRequest)
                               throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListEvents permission.

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

Parameters:

listEventsRequest - A Consumer that will call methods on ListEventsRequest.Builder to create a request.

Returns:

Result of the ListEvents operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listEventsPaginator

default ListEventsIterable listEventsPaginator(ListEventsRequest listEventsRequest)
                                        throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) 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.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client
             .listEventsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(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 listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.

Parameters:

listEventsRequest -

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listEventsPaginator

default ListEventsIterable listEventsPaginator(Consumer<ListEventsRequest.Builder> listEventsRequest)
                                        throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) 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.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client
             .listEventsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsIterable responses = client.listEventsPaginator(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 listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation.

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

Parameters:

listEventsRequest - A Consumer that will call methods on ListEventsRequest.Builder to create a request.

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryExtractionJobs

default ListMemoryExtractionJobsResponse listMemoryExtractionJobs(ListMemoryExtractionJobsRequest listMemoryExtractionJobsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.

To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.

Parameters:

listMemoryExtractionJobsRequest -

Returns:

Result of the ListMemoryExtractionJobs operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryExtractionJobs

default ListMemoryExtractionJobsResponse listMemoryExtractionJobs(Consumer<ListMemoryExtractionJobsRequest.Builder> listMemoryExtractionJobsRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all long-term memory extraction jobs that are eligible to be started with optional filtering.

To use this operation, you must have the bedrock-agentcore:ListMemoryExtractionJobs permission.

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

Parameters:

listMemoryExtractionJobsRequest - A Consumer that will call methods on ListMemoryExtractionJobsRequest.Builder to create a request.

Returns:

Result of the ListMemoryExtractionJobs operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryExtractionJobsPaginator

default ListMemoryExtractionJobsIterable listMemoryExtractionJobsPaginator(ListMemoryExtractionJobsRequest listMemoryExtractionJobsRequest)
                                                                    throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) 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.bedrockagentcore.paginators.ListMemoryExtractionJobsIterable responses = client.listMemoryExtractionJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsIterable responses = client
             .listMemoryExtractionJobsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsIterable responses = client.listMemoryExtractionJobsPaginator(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 listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) operation.

Parameters:

listMemoryExtractionJobsRequest -

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryExtractionJobsPaginator

default ListMemoryExtractionJobsIterable listMemoryExtractionJobsPaginator(Consumer<ListMemoryExtractionJobsRequest.Builder> listMemoryExtractionJobsRequest)
                                                                    throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) 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.bedrockagentcore.paginators.ListMemoryExtractionJobsIterable responses = client.listMemoryExtractionJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsIterable responses = client
             .listMemoryExtractionJobsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsIterable responses = client.listMemoryExtractionJobsPaginator(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 listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) operation.

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

Parameters:

listMemoryExtractionJobsRequest - A Consumer that will call methods on ListMemoryExtractionJobsRequest.Builder to create a request.

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryRecords

default ListMemoryRecordsResponse listMemoryRecords(ListMemoryRecordsRequest listMemoryRecordsRequest)
                                             throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.

Parameters:

listMemoryRecordsRequest -

Returns:

Result of the ListMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryRecords

default ListMemoryRecordsResponse listMemoryRecords(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)
                                             throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists memory records in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListMemoryRecords permission.

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

Parameters:

listMemoryRecordsRequest - A Consumer that will call methods on ListMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the ListMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryRecordsPaginator

default ListMemoryRecordsIterable listMemoryRecordsPaginator(ListMemoryRecordsRequest listMemoryRecordsRequest)
                                                      throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) 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.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client
             .listMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(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 listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.

Parameters:

listMemoryRecordsRequest -

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listMemoryRecordsPaginator

default ListMemoryRecordsIterable listMemoryRecordsPaginator(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)
                                                      throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) 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.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client
             .listMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsIterable responses = client.listMemoryRecordsPaginator(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 listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation.

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

Parameters:

listMemoryRecordsRequest - A Consumer that will call methods on ListMemoryRecordsRequest.Builder to create a request.

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentInstruments

default ListPaymentInstrumentsResponse listPaymentInstruments(ListPaymentInstrumentsRequest listPaymentInstrumentsRequest)
                                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

List payment instruments for a manager.

Parameters:

listPaymentInstrumentsRequest - Request structure for listing payment instruments.

Returns:

Result of the ListPaymentInstruments operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentInstruments

default ListPaymentInstrumentsResponse listPaymentInstruments(Consumer<ListPaymentInstrumentsRequest.Builder> listPaymentInstrumentsRequest)
                                                       throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

List payment instruments for a manager.

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

Parameters:

listPaymentInstrumentsRequest - A Consumer that will call methods on ListPaymentInstrumentsRequest.Builder to create a request. Request structure for listing payment instruments.

Returns:

Result of the ListPaymentInstruments operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentInstrumentsPaginator

default ListPaymentInstrumentsIterable listPaymentInstrumentsPaginator(ListPaymentInstrumentsRequest listPaymentInstrumentsRequest)
                                                                throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) 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.bedrockagentcore.paginators.ListPaymentInstrumentsIterable responses = client.listPaymentInstrumentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsIterable responses = client
             .listPaymentInstrumentsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsIterable responses = client.listPaymentInstrumentsPaginator(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 listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) operation.

Parameters:

listPaymentInstrumentsRequest - Request structure for listing payment instruments.

Returns:

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

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentInstrumentsPaginator

default ListPaymentInstrumentsIterable listPaymentInstrumentsPaginator(Consumer<ListPaymentInstrumentsRequest.Builder> listPaymentInstrumentsRequest)
                                                                throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) 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.bedrockagentcore.paginators.ListPaymentInstrumentsIterable responses = client.listPaymentInstrumentsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsIterable responses = client
             .listPaymentInstrumentsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsIterable responses = client.listPaymentInstrumentsPaginator(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 listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) operation.

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

Parameters:

listPaymentInstrumentsRequest - A Consumer that will call methods on ListPaymentInstrumentsRequest.Builder to create a request. Request structure for listing payment instruments.

Returns:

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

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentSessions

default ListPaymentSessionsResponse listPaymentSessions(ListPaymentSessionsRequest listPaymentSessionsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

List payment sessions.

Parameters:

listPaymentSessionsRequest - Request structure for listing payment sessions.

Returns:

Result of the ListPaymentSessions operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentSessions

default ListPaymentSessionsResponse listPaymentSessions(Consumer<ListPaymentSessionsRequest.Builder> listPaymentSessionsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

List payment sessions.

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

Parameters:

listPaymentSessionsRequest - A Consumer that will call methods on ListPaymentSessionsRequest.Builder to create a request. Request structure for listing payment sessions.

Returns:

Result of the ListPaymentSessions operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentSessionsPaginator

default ListPaymentSessionsIterable listPaymentSessionsPaginator(ListPaymentSessionsRequest listPaymentSessionsRequest)
                                                          throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) 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.bedrockagentcore.paginators.ListPaymentSessionsIterable responses = client.listPaymentSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsIterable responses = client
             .listPaymentSessionsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsIterable responses = client.listPaymentSessionsPaginator(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 listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) operation.

Parameters:

listPaymentSessionsRequest - Request structure for listing payment sessions.

Returns:

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

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listPaymentSessionsPaginator

default ListPaymentSessionsIterable listPaymentSessionsPaginator(Consumer<ListPaymentSessionsRequest.Builder> listPaymentSessionsRequest)
                                                          throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) 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.bedrockagentcore.paginators.ListPaymentSessionsIterable responses = client.listPaymentSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsIterable responses = client
             .listPaymentSessionsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsIterable responses = client.listPaymentSessionsPaginator(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 listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) operation.

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

Parameters:

listPaymentSessionsRequest - A Consumer that will call methods on ListPaymentSessionsRequest.Builder to create a request. Request structure for listing payment sessions.

Returns:

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

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listRecommendations

default ListRecommendationsResponse listRecommendations(ListRecommendationsRequest listRecommendationsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all recommendations in the account, with optional filtering by status.

Parameters:

listRecommendationsRequest -

Returns:

Result of the ListRecommendations operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listRecommendations

default ListRecommendationsResponse listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)
                                                 throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists all recommendations in the account, with optional filtering by status.

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

Parameters:

listRecommendationsRequest - A Consumer that will call methods on ListRecommendationsRequest.Builder to create a request.

Returns:

Result of the ListRecommendations operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listRecommendationsPaginator

default ListRecommendationsIterable listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest)
                                                          throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) 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.bedrockagentcore.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsIterable responses = client
             .listRecommendationsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(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 listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) operation.

Parameters:

listRecommendationsRequest -

Returns:

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

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listRecommendationsPaginator

default ListRecommendationsIterable listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)
                                                          throws AccessDeniedException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) 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.bedrockagentcore.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsIterable responses = client
             .listRecommendationsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsIterable responses = client.listRecommendationsPaginator(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 listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) operation.

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

Parameters:

listRecommendationsRequest - A Consumer that will call methods on ListRecommendationsRequest.Builder to create a request.

Returns:

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

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listSessions

default ListSessionsResponse listSessions(ListSessionsRequest listSessionsRequest)
                                   throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

Empty sessions are automatically deleted after one day.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

Parameters:

listSessionsRequest -

Returns:

Result of the ListSessions operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listSessions

default ListSessionsResponse listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)
                                   throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Lists sessions in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

Empty sessions are automatically deleted after one day.

To use this operation, you must have the bedrock-agentcore:ListSessions permission.

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.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listSessionsPaginator

default ListSessionsIterable listSessionsPaginator(ListSessionsRequest listSessionsRequest)
                                            throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.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.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.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.bedrockagentcore.model.ListSessionsRequest) operation.

Parameters:

listSessionsRequest -

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

listSessionsPaginator

default ListSessionsIterable listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)
                                            throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.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.bedrockagentcore.paginators.ListSessionsIterable responses = client.listSessionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

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

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.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.bedrockagentcore.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.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

processPayment

default ProcessPaymentResponse processPayment(ProcessPaymentRequest processPaymentRequest)
                                       throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Processes a payment using a payment instrument within a payment session.

Parameters:

processPaymentRequest - Request structure for processing a payment.

Returns:

Result of the ProcessPayment operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

processPayment

default ProcessPaymentResponse processPayment(Consumer<ProcessPaymentRequest.Builder> processPaymentRequest)
                                       throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Processes a payment using a payment instrument within a payment session.

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

Parameters:

processPaymentRequest - A Consumer that will call methods on ProcessPaymentRequest.Builder to create a request. Request structure for processing a payment.

Returns:

Result of the ProcessPayment operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

retrieveMemoryRecords

default RetrieveMemoryRecordsResponse retrieveMemoryRecords(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)
                                                     throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.

Parameters:

retrieveMemoryRecordsRequest -

Returns:

Result of the RetrieveMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

retrieveMemoryRecords

default RetrieveMemoryRecordsResponse retrieveMemoryRecords(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)
                                                     throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Searches for and retrieves memory records from an AgentCore Memory resource based on specified search criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:RetrieveMemoryRecords permission.

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

Parameters:

retrieveMemoryRecordsRequest - A Consumer that will call methods on RetrieveMemoryRecordsRequest.Builder to create a request.

Returns:

Result of the RetrieveMemoryRecords operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

retrieveMemoryRecordsPaginator

default RetrieveMemoryRecordsIterable retrieveMemoryRecordsPaginator(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)
                                                              throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) 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.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client
             .retrieveMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(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 retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.

Parameters:

retrieveMemoryRecordsRequest -

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

retrieveMemoryRecordsPaginator

default RetrieveMemoryRecordsIterable retrieveMemoryRecordsPaginator(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)
                                                              throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
InvalidInputException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) 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.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client
             .retrieveMemoryRecordsPaginator(request);
     for (software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsIterable responses = client.retrieveMemoryRecordsPaginator(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 retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation.

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

Parameters:

retrieveMemoryRecordsRequest - A Consumer that will call methods on RetrieveMemoryRecordsRequest.Builder to create a request.

Returns:

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

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

InvalidInputException - The input fails to satisfy the constraints specified by AgentCore. Check your input values and try again.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

saveBrowserSessionProfile

default SaveBrowserSessionProfileResponse saveBrowserSessionProfile(SaveBrowserSessionProfileRequest saveBrowserSessionProfileRequest)
                                                             throws AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.

To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operation to initialize new sessions with the stored browser state.

Browser profiles are useful for scenarios that require persistent authentication, maintaining user preferences across sessions, or continuing tasks that depend on previously stored browser data.

The following operations are related to SaveBrowserSessionProfile:

• StartBrowserSession

• GetBrowserSession

Parameters:

saveBrowserSessionProfileRequest -

Returns:

Result of the SaveBrowserSessionProfile operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

saveBrowserSessionProfile

default SaveBrowserSessionProfileResponse saveBrowserSessionProfile(Consumer<SaveBrowserSessionProfileRequest.Builder> saveBrowserSessionProfileRequest)
                                                             throws AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Saves the current state of a browser session as a reusable profile in Amazon Bedrock AgentCore. A browser profile captures persistent browser data such as cookies and local storage from an active session, enabling you to reuse this data in future browser sessions.

To save a browser session profile, you must specify the profile identifier, browser identifier, and session ID. The session must be active when saving the profile. Once saved, the profile can be used with the StartBrowserSession operation to initialize new sessions with the stored browser state.

Browser profiles are useful for scenarios that require persistent authentication, maintaining user preferences across sessions, or continuing tasks that depend on previously stored browser data.

The following operations are related to SaveBrowserSessionProfile:

• StartBrowserSession

• GetBrowserSession

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

Parameters:

saveBrowserSessionProfileRequest - A Consumer that will call methods on SaveBrowserSessionProfileRequest.Builder to create a request.

Returns:

Result of the SaveBrowserSessionProfile operation returned by the service.

Throws:

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

searchRegistryRecords

default SearchRegistryRecordsResponse searchRegistryRecords(SearchRegistryRecordsRequest searchRegistryRecordsRequest)
                                                     throws UnauthorizedException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.

Parameters:

searchRegistryRecordsRequest -

Returns:

Result of the SearchRegistryRecords operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

searchRegistryRecords

default SearchRegistryRecordsResponse searchRegistryRecords(Consumer<SearchRegistryRecordsRequest.Builder> searchRegistryRecordsRequest)
                                                     throws UnauthorizedException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.

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

Parameters:

searchRegistryRecordsRequest - A Consumer that will call methods on SearchRegistryRecordsRequest.Builder to create a request.

Returns:

Result of the SearchRegistryRecords operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startBatchEvaluation

default StartBatchEvaluationResponse startBatchEvaluation(StartBatchEvaluationRequest startBatchEvaluationRequest)
                                                   throws ServiceQuotaExceededException,
UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.

Parameters:

startBatchEvaluationRequest -

Returns:

Result of the StartBatchEvaluation operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startBatchEvaluation

default StartBatchEvaluationResponse startBatchEvaluation(Consumer<StartBatchEvaluationRequest.Builder> startBatchEvaluationRequest)
                                                   throws ServiceQuotaExceededException,
UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Starts a batch evaluation job that evaluates agent performance across multiple sessions. Batch evaluations pull agent traces from CloudWatch Logs or an existing online evaluation configuration and run specified evaluators and insights against them.

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

Parameters:

startBatchEvaluationRequest - A Consumer that will call methods on StartBatchEvaluationRequest.Builder to create a request.

Returns:

Result of the StartBatchEvaluation operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startBrowserSession

default StartBrowserSessionResponse startBrowserSession(StartBrowserSessionRequest startBrowserSessionRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.

To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.

The following operations are related to StartBrowserSession:

• GetBrowserSession

• UpdateBrowserStream

• SaveBrowserSessionProfile

• StopBrowserSession

• InvokeBrowser

Parameters:

startBrowserSessionRequest -

Returns:

Result of the StartBrowserSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startBrowserSession

default StartBrowserSessionResponse startBrowserSession(Consumer<StartBrowserSessionRequest.Builder> startBrowserSessionRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a browser session in Amazon Bedrock AgentCore. The session enables agents to navigate and interact with web content, extract information from websites, and perform web-based tasks as part of their response generation.

To create a session, you must specify a browser identifier and a name. You can also configure the viewport dimensions to control the visible area of web content. The session remains active until it times out or you explicitly stop it using the StopBrowserSession operation.

The following operations are related to StartBrowserSession:

• GetBrowserSession

• UpdateBrowserStream

• SaveBrowserSessionProfile

• StopBrowserSession

• InvokeBrowser

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

Parameters:

startBrowserSessionRequest - A Consumer that will call methods on StartBrowserSessionRequest.Builder to create a request.

Returns:

Result of the StartBrowserSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startCodeInterpreterSession

default StartCodeInterpreterSessionResponse startCodeInterpreterSession(StartCodeInterpreterSessionRequest startCodeInterpreterSessionRequest)
                                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.

To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.

The following operations are related to StartCodeInterpreterSession:

• InvokeCodeInterpreter

• GetCodeInterpreterSession

• StopCodeInterpreterSession

Parameters:

startCodeInterpreterSessionRequest -

Returns:

Result of the StartCodeInterpreterSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startCodeInterpreterSession

default StartCodeInterpreterSessionResponse startCodeInterpreterSession(Consumer<StartCodeInterpreterSessionRequest.Builder> startCodeInterpreterSessionRequest)
                                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Creates and initializes a code interpreter session in Amazon Bedrock AgentCore. The session enables agents to execute code as part of their response generation, supporting programming languages such as Python for data analysis, visualization, and computation tasks.

To create a session, you must specify a code interpreter identifier and a name. The session remains active until it times out or you explicitly stop it using the StopCodeInterpreterSession operation.

The following operations are related to StartCodeInterpreterSession:

• InvokeCodeInterpreter

• GetCodeInterpreterSession

• StopCodeInterpreterSession

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

Parameters:

startCodeInterpreterSessionRequest - A Consumer that will call methods on StartCodeInterpreterSessionRequest.Builder to create a request.

Returns:

Result of the StartCodeInterpreterSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startMemoryExtractionJob

default StartMemoryExtractionJobResponse startMemoryExtractionJob(StartMemoryExtractionJobRequest startMemoryExtractionJobRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.

To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.

Parameters:

startMemoryExtractionJobRequest -

Returns:

Result of the StartMemoryExtractionJob operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startMemoryExtractionJob

default StartMemoryExtractionJobResponse startMemoryExtractionJob(Consumer<StartMemoryExtractionJobRequest.Builder> startMemoryExtractionJobRequest)
                                                           throws ServiceQuotaExceededException,
ThrottledException,
ServiceException,
AccessDeniedException,
ValidationException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Starts a memory extraction job that processes events that failed extraction previously in an AgentCore Memory resource and produces structured memory records. When earlier extraction attempts have left events unprocessed, this job will pick up and extract those as well.

To use this operation, you must have the bedrock-agentcore:StartMemoryExtractionJob permission.

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

Parameters:

startMemoryExtractionJobRequest - A Consumer that will call methods on StartMemoryExtractionJobRequest.Builder to create a request.

Returns:

Result of the StartMemoryExtractionJob operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

ThrottledException - The request was denied due to request throttling. Reduce the frequency of requests and try again.

ServiceException - The service encountered an internal error. Try your request again later.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startRecommendation

default StartRecommendationResponse startRecommendation(StartRecommendationRequest startRecommendationRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.

Parameters:

startRecommendationRequest -

Returns:

Result of the StartRecommendation operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

startRecommendation

default StartRecommendationResponse startRecommendation(Consumer<StartRecommendationRequest.Builder> startRecommendationRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Starts a recommendation job that analyzes agent traces and generates optimization suggestions for system prompts or tool descriptions to improve agent performance.

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

Parameters:

startRecommendationRequest - A Consumer that will call methods on StartRecommendationRequest.Builder to create a request.

Returns:

Result of the StartRecommendation operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopBatchEvaluation

default StopBatchEvaluationResponse stopBatchEvaluation(StopBatchEvaluationRequest stopBatchEvaluationRequest)
                                                 throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Stops a running batch evaluation. Sessions that have already been evaluated retain their results.

Parameters:

stopBatchEvaluationRequest -

Returns:

Result of the StopBatchEvaluation operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopBatchEvaluation

default StopBatchEvaluationResponse stopBatchEvaluation(Consumer<StopBatchEvaluationRequest.Builder> stopBatchEvaluationRequest)
                                                 throws UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Stops a running batch evaluation. Sessions that have already been evaluated retain their results.

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

Parameters:

stopBatchEvaluationRequest - A Consumer that will call methods on StopBatchEvaluationRequest.Builder to create a request.

Returns:

Result of the StopBatchEvaluation operation returned by the service.

Throws:

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopBrowserSession

default StopBrowserSessionResponse stopBrowserSession(StopBrowserSessionRequest stopBrowserSessionRequest)
                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession.

The following operations are related to StopBrowserSession:

• StartBrowserSession

• GetBrowserSession

Parameters:

stopBrowserSessionRequest -

Returns:

Result of the StopBrowserSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopBrowserSession

default StopBrowserSessionResponse stopBrowserSession(Consumer<StopBrowserSessionRequest.Builder> stopBrowserSessionRequest)
                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active browser session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a browser session, you must specify both the browser identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartBrowserSession.

The following operations are related to StopBrowserSession:

• StartBrowserSession

• GetBrowserSession

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

Parameters:

stopBrowserSessionRequest - A Consumer that will call methods on StopBrowserSessionRequest.Builder to create a request.

Returns:

Result of the StopBrowserSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopCodeInterpreterSession

default StopCodeInterpreterSessionResponse stopCodeInterpreterSession(StopCodeInterpreterSessionRequest stopCodeInterpreterSessionRequest)
                                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession.

The following operations are related to StopCodeInterpreterSession:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

Parameters:

stopCodeInterpreterSessionRequest -

Returns:

Result of the StopCodeInterpreterSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopCodeInterpreterSession

default StopCodeInterpreterSessionResponse stopCodeInterpreterSession(Consumer<StopCodeInterpreterSessionRequest.Builder> stopCodeInterpreterSessionRequest)
                                                               throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Terminates an active code interpreter session in Amazon Bedrock AgentCore. This operation stops the session, releases associated resources, and makes the session unavailable for further use.

To stop a code interpreter session, you must specify both the code interpreter identifier and the session ID. Once stopped, a session cannot be restarted; you must create a new session using StartCodeInterpreterSession.

The following operations are related to StopCodeInterpreterSession:

• StartCodeInterpreterSession

• GetCodeInterpreterSession

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

Parameters:

stopCodeInterpreterSessionRequest - A Consumer that will call methods on StopCodeInterpreterSessionRequest.Builder to create a request.

Returns:

Result of the StopCodeInterpreterSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopRuntimeSession

default StopRuntimeSessionResponse stopRuntimeSession(StopRuntimeSessionRequest stopRuntimeSessionRequest)
                                               throws ServiceQuotaExceededException,
UnauthorizedException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
ConflictException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Stops a session that is running in an running AgentCore Runtime agent.

Parameters:

stopRuntimeSessionRequest -

Returns:

Result of the StopRuntimeSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

stopRuntimeSession

default StopRuntimeSessionResponse stopRuntimeSession(Consumer<StopRuntimeSessionRequest.Builder> stopRuntimeSessionRequest)
                                               throws ServiceQuotaExceededException,
UnauthorizedException,
RetryableConflictException,
ValidationException,
AccessDeniedException,
ConflictException,
RuntimeClientErrorException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Stops a session that is running in an running AgentCore Runtime agent.

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

Parameters:

stopRuntimeSessionRequest - A Consumer that will call methods on StopRuntimeSessionRequest.Builder to create a request.

Returns:

Result of the StopRuntimeSession operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

RetryableConflictException - The exception that occurs when there is a retryable conflict performing an operation. This is a temporary condition that may resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

RuntimeClientErrorException - The exception that occurs when there is an error in the runtime client. This can happen due to network issues, invalid configuration, or other client-side problems. Check the error message for specific details about the error.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

updateABTest

default UpdateAbTestResponse updateABTest(UpdateAbTestRequest updateAbTestRequest)
                                   throws ServiceQuotaExceededException,
UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.

Parameters:

updateAbTestRequest -

Returns:

Result of the UpdateABTest operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

updateABTest

default UpdateAbTestResponse updateABTest(Consumer<UpdateAbTestRequest.Builder> updateAbTestRequest)
                                   throws ServiceQuotaExceededException,
UnauthorizedException,
ValidationException,
AccessDeniedException,
ConflictException,
ThrottlingException,
ResourceNotFoundException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.

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

Parameters:

updateAbTestRequest - A Consumer that will call methods on UpdateAbTestRequest.Builder to create a request.

Returns:

Result of the UpdateABTest operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

UnauthorizedException - This exception is thrown when the JWT bearer token is invalid or not found for OAuth bearer token based access

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

updateBrowserStream

default UpdateBrowserStreamResponse updateBrowserStream(UpdateBrowserStreamRequest updateBrowserStreamRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

Parameters:

updateBrowserStreamRequest -

Returns:

Result of the UpdateBrowserStream operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

updateBrowserStream

default UpdateBrowserStreamResponse updateBrowserStream(Consumer<UpdateBrowserStreamRequest.Builder> updateBrowserStreamRequest)
                                                 throws ServiceQuotaExceededException,
AccessDeniedException,
ConflictException,
ValidationException,
ResourceNotFoundException,
ThrottlingException,
InternalServerException,
AwsServiceException,
SdkClientException,
BedrockAgentCoreException

Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

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

Parameters:

updateBrowserStreamRequest - A Consumer that will call methods on UpdateBrowserStreamRequest.Builder to create a request.

Returns:

Result of the UpdateBrowserStream operation returned by the service.

Throws:

ServiceQuotaExceededException - The exception that occurs when the request would cause a service quota to be exceeded. Review your service quotas and either reduce your request rate or request a quota increase.

AccessDeniedException - The exception that occurs when you do not have sufficient permissions to perform an action. Verify that your IAM policy includes the necessary permissions for the operation you are trying to perform.

ConflictException - The exception that occurs when the request conflicts with the current state of the resource. This can happen when trying to modify a resource that is currently being modified by another request, or when trying to create a resource that already exists.

ValidationException - The exception that occurs when the input fails to satisfy the constraints specified by the service. Check the error message for details about which input parameter is invalid and correct your request.

ResourceNotFoundException - The exception that occurs when the specified resource does not exist. This can happen when using an invalid identifier or when trying to access a resource that has been deleted.

ThrottlingException - The exception that occurs when the request was denied due to request throttling. This happens when you exceed the allowed request rate for an operation. Reduce the frequency of requests or implement exponential backoff retry logic in your application.

InternalServerException - The exception that occurs when the service encounters an unexpected internal error. This is a temporary condition that will resolve itself with retries. We recommend implementing exponential backoff retry logic in your application.

SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.

BedrockAgentCoreException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

• AWS API Documentation

create

static BedrockAgentCoreClient create()

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

builder

static BedrockAgentCoreClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default BedrockAgentCoreServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient