Interface BedrockAgentCoreAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface BedrockAgentCoreAsyncClient extends AwsClient
Service client for accessing Amazon Bedrock AgentCore asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • batchCreateMemoryRecords

      default CompletableFuture<BatchCreateMemoryRecordsResponse> batchCreateMemoryRecords(BatchCreateMemoryRecordsRequest batchCreateMemoryRecordsRequest)

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

      Parameters:
      batchCreateMemoryRecordsRequest -
      Returns:
      A Java Future containing the result of the BatchCreateMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchCreateMemoryRecords

      default CompletableFuture<BatchCreateMemoryRecordsResponse> batchCreateMemoryRecords(Consumer<BatchCreateMemoryRecordsRequest.Builder> batchCreateMemoryRecordsRequest)

      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:
      A Java Future containing the result of the BatchCreateMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchDeleteMemoryRecords

      default CompletableFuture<BatchDeleteMemoryRecordsResponse> batchDeleteMemoryRecords(BatchDeleteMemoryRecordsRequest batchDeleteMemoryRecordsRequest)

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

      Parameters:
      batchDeleteMemoryRecordsRequest -
      Returns:
      A Java Future containing the result of the BatchDeleteMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchDeleteMemoryRecords

      default CompletableFuture<BatchDeleteMemoryRecordsResponse> batchDeleteMemoryRecords(Consumer<BatchDeleteMemoryRecordsRequest.Builder> batchDeleteMemoryRecordsRequest)

      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:
      A Java Future containing the result of the BatchDeleteMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchUpdateMemoryRecords

      default CompletableFuture<BatchUpdateMemoryRecordsResponse> batchUpdateMemoryRecords(BatchUpdateMemoryRecordsRequest batchUpdateMemoryRecordsRequest)

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

      Parameters:
      batchUpdateMemoryRecordsRequest -
      Returns:
      A Java Future containing the result of the BatchUpdateMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • batchUpdateMemoryRecords

      default CompletableFuture<BatchUpdateMemoryRecordsResponse> batchUpdateMemoryRecords(Consumer<BatchUpdateMemoryRecordsRequest.Builder> batchUpdateMemoryRecordsRequest)

      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:
      A Java Future containing the result of the BatchUpdateMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • completeResourceTokenAuth

      default CompletableFuture<CompleteResourceTokenAuthResponse> completeResourceTokenAuth(CompleteResourceTokenAuthRequest completeResourceTokenAuthRequest)

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

      Parameters:
      completeResourceTokenAuthRequest -
      Returns:
      A Java Future containing the result of the CompleteResourceTokenAuth operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • completeResourceTokenAuth

      default CompletableFuture<CompleteResourceTokenAuthResponse> completeResourceTokenAuth(Consumer<CompleteResourceTokenAuthRequest.Builder> completeResourceTokenAuthRequest)

      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:
      A Java Future containing the result of the CompleteResourceTokenAuth operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createABTest

      default CompletableFuture<CreateAbTestResponse> createABTest(CreateAbTestRequest createAbTestRequest)

      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:
      A Java Future containing the result of the CreateABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createABTest

      default CompletableFuture<CreateAbTestResponse> createABTest(Consumer<CreateAbTestRequest.Builder> createAbTestRequest)

      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:
      A Java Future containing the result of the CreateABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createEvent

      default CompletableFuture<CreateEventResponse> createEvent(CreateEventRequest createEventRequest)

      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:
      A Java Future containing the result of the CreateEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createEvent

      default CompletableFuture<CreateEventResponse> createEvent(Consumer<CreateEventRequest.Builder> createEventRequest)

      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:
      A Java Future containing the result of the CreateEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createPaymentInstrument

      default CompletableFuture<CreatePaymentInstrumentResponse> createPaymentInstrument(CreatePaymentInstrumentRequest createPaymentInstrumentRequest)

      Create a new payment instrument for a connector.

      Parameters:
      createPaymentInstrumentRequest - Request structure for creating a payment instrument.
      Returns:
      A Java Future containing the result of the CreatePaymentInstrument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createPaymentInstrument

      default CompletableFuture<CreatePaymentInstrumentResponse> createPaymentInstrument(Consumer<CreatePaymentInstrumentRequest.Builder> createPaymentInstrumentRequest)

      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:
      A Java Future containing the result of the CreatePaymentInstrument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createPaymentSession

      default CompletableFuture<CreatePaymentSessionResponse> createPaymentSession(CreatePaymentSessionRequest createPaymentSessionRequest)

      Create a new payment session.

      Parameters:
      createPaymentSessionRequest - Request structure for creating a payment session.
      Returns:
      A Java Future containing the result of the CreatePaymentSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createPaymentSession

      default CompletableFuture<CreatePaymentSessionResponse> createPaymentSession(Consumer<CreatePaymentSessionRequest.Builder> createPaymentSessionRequest)

      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:
      A Java Future containing the result of the CreatePaymentSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteABTest

      default CompletableFuture<DeleteAbTestResponse> deleteABTest(DeleteAbTestRequest deleteAbTestRequest)

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

      Parameters:
      deleteAbTestRequest -
      Returns:
      A Java Future containing the result of the DeleteABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteABTest

      default CompletableFuture<DeleteAbTestResponse> deleteABTest(Consumer<DeleteAbTestRequest.Builder> deleteAbTestRequest)

      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:
      A Java Future containing the result of the DeleteABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteBatchEvaluation

      default CompletableFuture<DeleteBatchEvaluationResponse> deleteBatchEvaluation(DeleteBatchEvaluationRequest deleteBatchEvaluationRequest)

      Deletes a batch evaluation and its associated results.

      Parameters:
      deleteBatchEvaluationRequest -
      Returns:
      A Java Future containing the result of the DeleteBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteBatchEvaluation

      default CompletableFuture<DeleteBatchEvaluationResponse> deleteBatchEvaluation(Consumer<DeleteBatchEvaluationRequest.Builder> deleteBatchEvaluationRequest)

      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:
      A Java Future containing the result of the DeleteBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEvent

      default CompletableFuture<DeleteEventResponse> deleteEvent(DeleteEventRequest deleteEventRequest)

      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:
      A Java Future containing the result of the DeleteEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEvent

      default CompletableFuture<DeleteEventResponse> deleteEvent(Consumer<DeleteEventRequest.Builder> deleteEventRequest)

      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:
      A Java Future containing the result of the DeleteEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteMemoryRecord

      default CompletableFuture<DeleteMemoryRecordResponse> deleteMemoryRecord(DeleteMemoryRecordRequest deleteMemoryRecordRequest)

      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:
      A Java Future containing the result of the DeleteMemoryRecord operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteMemoryRecord

      default CompletableFuture<DeleteMemoryRecordResponse> deleteMemoryRecord(Consumer<DeleteMemoryRecordRequest.Builder> deleteMemoryRecordRequest)

      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:
      A Java Future containing the result of the DeleteMemoryRecord operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deletePaymentInstrument

      default CompletableFuture<DeletePaymentInstrumentResponse> deletePaymentInstrument(DeletePaymentInstrumentRequest deletePaymentInstrumentRequest)

      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:
      A Java Future containing the result of the DeletePaymentInstrument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deletePaymentInstrument

      default CompletableFuture<DeletePaymentInstrumentResponse> deletePaymentInstrument(Consumer<DeletePaymentInstrumentRequest.Builder> deletePaymentInstrumentRequest)

      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:
      A Java Future containing the result of the DeletePaymentInstrument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deletePaymentSession

      default CompletableFuture<DeletePaymentSessionResponse> deletePaymentSession(DeletePaymentSessionRequest deletePaymentSessionRequest)

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

      Parameters:
      deletePaymentSessionRequest - Request structure for deleting a payment session.
      Returns:
      A Java Future containing the result of the DeletePaymentSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deletePaymentSession

      default CompletableFuture<DeletePaymentSessionResponse> deletePaymentSession(Consumer<DeletePaymentSessionRequest.Builder> deletePaymentSessionRequest)

      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:
      A Java Future containing the result of the DeletePaymentSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRecommendation

      default CompletableFuture<DeleteRecommendationResponse> deleteRecommendation(DeleteRecommendationRequest deleteRecommendationRequest)

      Deletes a recommendation and its associated results.

      Parameters:
      deleteRecommendationRequest -
      Returns:
      A Java Future containing the result of the DeleteRecommendation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteRecommendation

      default CompletableFuture<DeleteRecommendationResponse> deleteRecommendation(Consumer<DeleteRecommendationRequest.Builder> deleteRecommendationRequest)

      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:
      A Java Future containing the result of the DeleteRecommendation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • evaluate

      default CompletableFuture<EvaluateResponse> evaluate(EvaluateRequest evaluateRequest)

      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:
      A Java Future containing the result of the Evaluate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • evaluate

      default CompletableFuture<EvaluateResponse> evaluate(Consumer<EvaluateRequest.Builder> evaluateRequest)

      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:
      A Java Future containing the result of the Evaluate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getABTest

      default CompletableFuture<GetAbTestResponse> getABTest(GetAbTestRequest getAbTestRequest)

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

      Parameters:
      getAbTestRequest -
      Returns:
      A Java Future containing the result of the GetABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getABTest

      default CompletableFuture<GetAbTestResponse> getABTest(Consumer<GetAbTestRequest.Builder> getAbTestRequest)

      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:
      A Java Future containing the result of the GetABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAgentCard

      default CompletableFuture<GetAgentCardResponse> getAgentCard(GetAgentCardRequest getAgentCardRequest)

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

      Parameters:
      getAgentCardRequest -
      Returns:
      A Java Future containing the result of the GetAgentCard operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getAgentCard

      default CompletableFuture<GetAgentCardResponse> getAgentCard(Consumer<GetAgentCardRequest.Builder> getAgentCardRequest)

      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:
      A Java Future containing the result of the GetAgentCard operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getBatchEvaluation

      default CompletableFuture<GetBatchEvaluationResponse> getBatchEvaluation(GetBatchEvaluationRequest getBatchEvaluationRequest)

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

      Parameters:
      getBatchEvaluationRequest -
      Returns:
      A Java Future containing the result of the GetBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getBatchEvaluation

      default CompletableFuture<GetBatchEvaluationResponse> getBatchEvaluation(Consumer<GetBatchEvaluationRequest.Builder> getBatchEvaluationRequest)

      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:
      A Java Future containing the result of the GetBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getBrowserSession

      default CompletableFuture<GetBrowserSessionResponse> getBrowserSession(GetBrowserSessionRequest getBrowserSessionRequest)

      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:

      Parameters:
      getBrowserSessionRequest -
      Returns:
      A Java Future containing the result of the GetBrowserSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getBrowserSession

      default CompletableFuture<GetBrowserSessionResponse> getBrowserSession(Consumer<GetBrowserSessionRequest.Builder> getBrowserSessionRequest)

      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:


      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:
      A Java Future containing the result of the GetBrowserSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCodeInterpreterSession

      default CompletableFuture<GetCodeInterpreterSessionResponse> getCodeInterpreterSession(GetCodeInterpreterSessionRequest getCodeInterpreterSessionRequest)

      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:

      Parameters:
      getCodeInterpreterSessionRequest -
      Returns:
      A Java Future containing the result of the GetCodeInterpreterSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getCodeInterpreterSession

      default CompletableFuture<GetCodeInterpreterSessionResponse> getCodeInterpreterSession(Consumer<GetCodeInterpreterSessionRequest.Builder> getCodeInterpreterSessionRequest)

      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:


      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:
      A Java Future containing the result of the GetCodeInterpreterSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getEvent

      default CompletableFuture<GetEventResponse> getEvent(GetEventRequest getEventRequest)

      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:
      A Java Future containing the result of the GetEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getEvent

      default CompletableFuture<GetEventResponse> getEvent(Consumer<GetEventRequest.Builder> getEventRequest)

      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:
      A Java Future containing the result of the GetEvent operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getMemoryRecord

      default CompletableFuture<GetMemoryRecordResponse> getMemoryRecord(GetMemoryRecordRequest getMemoryRecordRequest)

      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:
      A Java Future containing the result of the GetMemoryRecord operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getMemoryRecord

      default CompletableFuture<GetMemoryRecordResponse> getMemoryRecord(Consumer<GetMemoryRecordRequest.Builder> getMemoryRecordRequest)

      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:
      A Java Future containing the result of the GetMemoryRecord operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getPaymentInstrument

      default CompletableFuture<GetPaymentInstrumentResponse> getPaymentInstrument(GetPaymentInstrumentRequest getPaymentInstrumentRequest)

      Get a payment instrument by ID.

      Parameters:
      getPaymentInstrumentRequest - Request structure for getting a payment instrument.
      Returns:
      A Java Future containing the result of the GetPaymentInstrument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getPaymentInstrument

      default CompletableFuture<GetPaymentInstrumentResponse> getPaymentInstrument(Consumer<GetPaymentInstrumentRequest.Builder> getPaymentInstrumentRequest)

      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:
      A Java Future containing the result of the GetPaymentInstrument operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getPaymentInstrumentBalance

      default CompletableFuture<GetPaymentInstrumentBalanceResponse> getPaymentInstrumentBalance(GetPaymentInstrumentBalanceRequest getPaymentInstrumentBalanceRequest)

      Get the balance of a payment instrument.

      Parameters:
      getPaymentInstrumentBalanceRequest - Request structure for getting payment instrument balance.
      Returns:
      A Java Future containing the result of the GetPaymentInstrumentBalance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getPaymentInstrumentBalance

      default CompletableFuture<GetPaymentInstrumentBalanceResponse> getPaymentInstrumentBalance(Consumer<GetPaymentInstrumentBalanceRequest.Builder> getPaymentInstrumentBalanceRequest)

      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:
      A Java Future containing the result of the GetPaymentInstrumentBalance operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getPaymentSession

      default CompletableFuture<GetPaymentSessionResponse> getPaymentSession(GetPaymentSessionRequest getPaymentSessionRequest)

      Get a payment session.

      Parameters:
      getPaymentSessionRequest - Request structure for getting a payment session.
      Returns:
      A Java Future containing the result of the GetPaymentSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getPaymentSession

      default CompletableFuture<GetPaymentSessionResponse> getPaymentSession(Consumer<GetPaymentSessionRequest.Builder> getPaymentSessionRequest)

      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:
      A Java Future containing the result of the GetPaymentSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getRecommendation

      default CompletableFuture<GetRecommendationResponse> getRecommendation(GetRecommendationRequest getRecommendationRequest)

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

      Parameters:
      getRecommendationRequest -
      Returns:
      A Java Future containing the result of the GetRecommendation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getRecommendation

      default CompletableFuture<GetRecommendationResponse> getRecommendation(Consumer<GetRecommendationRequest.Builder> getRecommendationRequest)

      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:
      A Java Future containing the result of the GetRecommendation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getResourceApiKey

      default CompletableFuture<GetResourceApiKeyResponse> getResourceApiKey(GetResourceApiKeyRequest getResourceApiKeyRequest)

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

      Parameters:
      getResourceApiKeyRequest -
      Returns:
      A Java Future containing the result of the GetResourceApiKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getResourceApiKey

      default CompletableFuture<GetResourceApiKeyResponse> getResourceApiKey(Consumer<GetResourceApiKeyRequest.Builder> getResourceApiKeyRequest)

      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:
      A Java Future containing the result of the GetResourceApiKey operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getResourceOauth2Token

      default CompletableFuture<GetResourceOauth2TokenResponse> getResourceOauth2Token(GetResourceOauth2TokenRequest getResourceOauth2TokenRequest)

      Returns the OAuth 2.0 token of the provided resource.

      Parameters:
      getResourceOauth2TokenRequest -
      Returns:
      A Java Future containing the result of the GetResourceOauth2Token operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getResourceOauth2Token

      default CompletableFuture<GetResourceOauth2TokenResponse> getResourceOauth2Token(Consumer<GetResourceOauth2TokenRequest.Builder> getResourceOauth2TokenRequest)

      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:
      A Java Future containing the result of the GetResourceOauth2Token operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getResourcePaymentToken

      default CompletableFuture<GetResourcePaymentTokenResponse> getResourcePaymentToken(GetResourcePaymentTokenRequest getResourcePaymentTokenRequest)

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

      Parameters:
      getResourcePaymentTokenRequest -
      Returns:
      A Java Future containing the result of the GetResourcePaymentToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getResourcePaymentToken

      default CompletableFuture<GetResourcePaymentTokenResponse> getResourcePaymentToken(Consumer<GetResourcePaymentTokenRequest.Builder> getResourcePaymentTokenRequest)

      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:
      A Java Future containing the result of the GetResourcePaymentToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkloadAccessToken

      default CompletableFuture<GetWorkloadAccessTokenResponse> getWorkloadAccessToken(GetWorkloadAccessTokenRequest getWorkloadAccessTokenRequest)

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

      Parameters:
      getWorkloadAccessTokenRequest -
      Returns:
      A Java Future containing the result of the GetWorkloadAccessToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkloadAccessToken

      default CompletableFuture<GetWorkloadAccessTokenResponse> getWorkloadAccessToken(Consumer<GetWorkloadAccessTokenRequest.Builder> getWorkloadAccessTokenRequest)

      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:
      A Java Future containing the result of the GetWorkloadAccessToken operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkloadAccessTokenForJWT

      default CompletableFuture<GetWorkloadAccessTokenForJwtResponse> getWorkloadAccessTokenForJWT(GetWorkloadAccessTokenForJwtRequest getWorkloadAccessTokenForJwtRequest)

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

      Parameters:
      getWorkloadAccessTokenForJwtRequest -
      Returns:
      A Java Future containing the result of the GetWorkloadAccessTokenForJWT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkloadAccessTokenForJWT

      default CompletableFuture<GetWorkloadAccessTokenForJwtResponse> getWorkloadAccessTokenForJWT(Consumer<GetWorkloadAccessTokenForJwtRequest.Builder> getWorkloadAccessTokenForJwtRequest)

      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:
      A Java Future containing the result of the GetWorkloadAccessTokenForJWT operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkloadAccessTokenForUserId

      default CompletableFuture<GetWorkloadAccessTokenForUserIdResponse> getWorkloadAccessTokenForUserId(GetWorkloadAccessTokenForUserIdRequest getWorkloadAccessTokenForUserIdRequest)

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

      Parameters:
      getWorkloadAccessTokenForUserIdRequest -
      Returns:
      A Java Future containing the result of the GetWorkloadAccessTokenForUserId operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • getWorkloadAccessTokenForUserId

      default CompletableFuture<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.


      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:
      A Java Future containing the result of the GetWorkloadAccessTokenForUserId operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeAgentRuntime

      default <ReturnT> CompletableFuture<ReturnT> invokeAgentRuntime(InvokeAgentRuntimeRequest invokeAgentRuntimeRequest, AsyncResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> asyncResponseTransformer)

      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 -
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned 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:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeAgentRuntime

      default <ReturnT> CompletableFuture<ReturnT> invokeAgentRuntime(Consumer<InvokeAgentRuntimeRequest.Builder> invokeAgentRuntimeRequest, AsyncResponseTransformer<InvokeAgentRuntimeResponse,ReturnT> asyncResponseTransformer)

      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.
      asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See AsyncResponseTransformer for details on how this callback should be implemented and for links to precanned 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:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeAgentRuntime

      default CompletableFuture<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.

      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:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeAgentRuntime

      default CompletableFuture<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.

      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:
      A future to the transformed result of the AsyncResponseTransformer.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeAgentRuntimeCommand

      default CompletableFuture<Void> invokeAgentRuntimeCommand(InvokeAgentRuntimeCommandRequest invokeAgentRuntimeCommandRequest, InvokeAgentRuntimeCommandResponseHandler asyncResponseHandler)

      Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.

      To invoke a command, you must specify the agent runtime ARN and a runtime session ID. The command execution supports streaming responses, allowing you to receive output as it becomes available through contentStart, contentDelta, and contentStop events.

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

      Parameters:
      invokeAgentRuntimeCommandRequest - Request for InvokeAgentRuntimeCommand operation.
      Returns:
      A Java Future containing the result of the InvokeAgentRuntimeCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeAgentRuntimeCommand

      default CompletableFuture<Void> invokeAgentRuntimeCommand(Consumer<InvokeAgentRuntimeCommandRequest.Builder> invokeAgentRuntimeCommandRequest, InvokeAgentRuntimeCommandResponseHandler asyncResponseHandler)

      Executes a command in a runtime session container and streams the output back to the caller. This operation allows you to run shell commands within the agent runtime environment and receive real-time streaming responses including standard output and standard error.

      To invoke a command, you must specify the agent runtime ARN and a runtime session ID. The command execution supports streaming responses, allowing you to receive output as it becomes available through contentStart, contentDelta, and contentStop events.

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


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

      Parameters:
      invokeAgentRuntimeCommandRequest - A Consumer that will call methods on InvokeAgentRuntimeCommandRequest.Builder to create a request. Request for InvokeAgentRuntimeCommand operation.
      Returns:
      A Java Future containing the result of the InvokeAgentRuntimeCommand operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeBrowser

      default CompletableFuture<InvokeBrowserResponse> invokeBrowser(InvokeBrowserRequest invokeBrowserRequest)

      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:

      Parameters:
      invokeBrowserRequest - Request for the InvokeBrowser operation.
      Returns:
      A Java Future containing the result of the InvokeBrowser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeBrowser

      default CompletableFuture<InvokeBrowserResponse> invokeBrowser(Consumer<InvokeBrowserRequest.Builder> invokeBrowserRequest)

      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:


      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:
      A Java Future containing the result of the InvokeBrowser operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeCodeInterpreter

      default CompletableFuture<Void> invokeCodeInterpreter(InvokeCodeInterpreterRequest invokeCodeInterpreterRequest, InvokeCodeInterpreterResponseHandler asyncResponseHandler)

      Executes code within an active code interpreter session in Amazon Bedrock AgentCore. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.

      To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.

      This operation is subject to request rate limiting based on your account's service quotas.

      The following operations are related to InvokeCodeInterpreter:

      Parameters:
      invokeCodeInterpreterRequest -
      Returns:
      A Java Future containing the result of the InvokeCodeInterpreter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeCodeInterpreter

      default CompletableFuture<Void> invokeCodeInterpreter(Consumer<InvokeCodeInterpreterRequest.Builder> invokeCodeInterpreterRequest, InvokeCodeInterpreterResponseHandler asyncResponseHandler)

      Executes code within an active code interpreter session in Amazon Bedrock AgentCore. This operation processes the provided code, runs it in a secure environment, and returns the execution results including output, errors, and generated visualizations.

      To execute code, you must specify the code interpreter identifier, session ID, and the code to run in the arguments parameter. The operation returns a stream containing the execution results, which can include text output, error messages, and data visualizations.

      This operation is subject to request rate limiting based on your account's service quotas.

      The following operations are related to InvokeCodeInterpreter:


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

      Parameters:
      invokeCodeInterpreterRequest - A Consumer that will call methods on InvokeCodeInterpreterRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the InvokeCodeInterpreter operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeHarness

      default CompletableFuture<Void> invokeHarness(InvokeHarnessRequest invokeHarnessRequest, InvokeHarnessResponseHandler asyncResponseHandler)

      Operation to invoke a Harness.

      Parameters:
      invokeHarnessRequest -
      Returns:
      A Java Future containing the result of the InvokeHarness operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • invokeHarness

      default CompletableFuture<Void> invokeHarness(Consumer<InvokeHarnessRequest.Builder> invokeHarnessRequest, InvokeHarnessResponseHandler asyncResponseHandler)

      Operation to invoke a Harness.


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

      Parameters:
      invokeHarnessRequest - A Consumer that will call methods on InvokeHarnessRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the InvokeHarness operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listABTests

      default CompletableFuture<ListAbTestsResponse> listABTests(ListAbTestsRequest listAbTestsRequest)

      Lists all A/B tests in the account.

      Parameters:
      listAbTestsRequest -
      Returns:
      A Java Future containing the result of the ListABTests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listABTests

      default CompletableFuture<ListAbTestsResponse> listABTests(Consumer<ListAbTestsRequest.Builder> listAbTestsRequest)

      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:
      A Java Future containing the result of the ListABTests operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listABTestsPaginator

      default ListABTestsPublisher listABTestsPaginator(ListAbTestsRequest listAbTestsRequest)

      This is a variant of listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsPublisher publisher = client.listABTestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsPublisher publisher = client.listABTestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listABTestsPaginator

      default ListABTestsPublisher listABTestsPaginator(Consumer<ListAbTestsRequest.Builder> listAbTestsRequest)

      This is a variant of listABTests(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsPublisher publisher = client.listABTestsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListABTestsPublisher publisher = client.listABTestsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListAbTestsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listActors

      default CompletableFuture<ListActorsResponse> listActors(ListActorsRequest listActorsRequest)

      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:
      A Java Future containing the result of the ListActors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listActors

      default CompletableFuture<ListActorsResponse> listActors(Consumer<ListActorsRequest.Builder> listActorsRequest)

      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:
      A Java Future containing the result of the ListActors operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listActorsPaginator

      default ListActorsPublisher listActorsPaginator(ListActorsRequest listActorsRequest)

      This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsPublisher publisher = client.listActorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsPublisher publisher = client.listActorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listActorsPaginator

      default ListActorsPublisher listActorsPaginator(Consumer<ListActorsRequest.Builder> listActorsRequest)

      This is a variant of listActors(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsPublisher publisher = client.listActorsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListActorsPublisher publisher = client.listActorsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListActorsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchEvaluations

      default CompletableFuture<ListBatchEvaluationsResponse> listBatchEvaluations(ListBatchEvaluationsRequest listBatchEvaluationsRequest)

      Lists all batch evaluations in the account, providing summary information about each evaluation's status and configuration.

      Parameters:
      listBatchEvaluationsRequest -
      Returns:
      A Java Future containing the result of the ListBatchEvaluations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchEvaluations

      default CompletableFuture<ListBatchEvaluationsResponse> listBatchEvaluations(Consumer<ListBatchEvaluationsRequest.Builder> listBatchEvaluationsRequest)

      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:
      A Java Future containing the result of the ListBatchEvaluations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchEvaluationsPaginator

      default ListBatchEvaluationsPublisher listBatchEvaluationsPaginator(ListBatchEvaluationsRequest listBatchEvaluationsRequest)

      This is a variant of listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsPublisher publisher = client.listBatchEvaluationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsPublisher publisher = client.listBatchEvaluationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBatchEvaluationsPaginator

      default ListBatchEvaluationsPublisher listBatchEvaluationsPaginator(Consumer<ListBatchEvaluationsRequest.Builder> listBatchEvaluationsRequest)

      This is a variant of listBatchEvaluations(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsPublisher publisher = client.listBatchEvaluationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListBatchEvaluationsPublisher publisher = client.listBatchEvaluationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListBatchEvaluationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBrowserSessions

      default CompletableFuture<ListBrowserSessionsResponse> listBrowserSessions(ListBrowserSessionsRequest listBrowserSessionsRequest)

      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:

      Parameters:
      listBrowserSessionsRequest -
      Returns:
      A Java Future containing the result of the ListBrowserSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listBrowserSessions

      default CompletableFuture<ListBrowserSessionsResponse> listBrowserSessions(Consumer<ListBrowserSessionsRequest.Builder> listBrowserSessionsRequest)

      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:


      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:
      A Java Future containing the result of the ListBrowserSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCodeInterpreterSessions

      default CompletableFuture<ListCodeInterpreterSessionsResponse> listCodeInterpreterSessions(ListCodeInterpreterSessionsRequest listCodeInterpreterSessionsRequest)

      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:

      Parameters:
      listCodeInterpreterSessionsRequest -
      Returns:
      A Java Future containing the result of the ListCodeInterpreterSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listCodeInterpreterSessions

      default CompletableFuture<ListCodeInterpreterSessionsResponse> listCodeInterpreterSessions(Consumer<ListCodeInterpreterSessionsRequest.Builder> listCodeInterpreterSessionsRequest)

      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:


      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:
      A Java Future containing the result of the ListCodeInterpreterSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEvents

      default CompletableFuture<ListEventsResponse> listEvents(ListEventsRequest listEventsRequest)

      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:
      A Java Future containing the result of the ListEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEvents

      default CompletableFuture<ListEventsResponse> listEvents(Consumer<ListEventsRequest.Builder> listEventsRequest)

      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:
      A Java Future containing the result of the ListEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventsPaginator

      default ListEventsPublisher listEventsPaginator(ListEventsRequest listEventsRequest)

      This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsPublisher publisher = client.listEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsPublisher publisher = client.listEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listEventsPaginator

      default ListEventsPublisher listEventsPaginator(Consumer<ListEventsRequest.Builder> listEventsRequest)

      This is a variant of listEvents(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsPublisher publisher = client.listEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListEventsPublisher publisher = client.listEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryExtractionJobs

      default CompletableFuture<ListMemoryExtractionJobsResponse> listMemoryExtractionJobs(ListMemoryExtractionJobsRequest listMemoryExtractionJobsRequest)

      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:
      A Java Future containing the result of the ListMemoryExtractionJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryExtractionJobs

      default CompletableFuture<ListMemoryExtractionJobsResponse> listMemoryExtractionJobs(Consumer<ListMemoryExtractionJobsRequest.Builder> listMemoryExtractionJobsRequest)

      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:
      A Java Future containing the result of the ListMemoryExtractionJobs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryExtractionJobsPaginator

      default ListMemoryExtractionJobsPublisher listMemoryExtractionJobsPaginator(ListMemoryExtractionJobsRequest listMemoryExtractionJobsRequest)

      This is a variant of listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsPublisher publisher = client.listMemoryExtractionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsPublisher publisher = client.listMemoryExtractionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryExtractionJobsPaginator

      default ListMemoryExtractionJobsPublisher listMemoryExtractionJobsPaginator(Consumer<ListMemoryExtractionJobsRequest.Builder> listMemoryExtractionJobsRequest)

      This is a variant of listMemoryExtractionJobs(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsPublisher publisher = client.listMemoryExtractionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryExtractionJobsPublisher publisher = client.listMemoryExtractionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryExtractionJobsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryRecords

      default CompletableFuture<ListMemoryRecordsResponse> listMemoryRecords(ListMemoryRecordsRequest listMemoryRecordsRequest)

      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:
      A Java Future containing the result of the ListMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryRecords

      default CompletableFuture<ListMemoryRecordsResponse> listMemoryRecords(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)

      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:
      A Java Future containing the result of the ListMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryRecordsPaginator

      default ListMemoryRecordsPublisher listMemoryRecordsPaginator(ListMemoryRecordsRequest listMemoryRecordsRequest)

      This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsPublisher publisher = client.listMemoryRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsPublisher publisher = client.listMemoryRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listMemoryRecordsPaginator

      default ListMemoryRecordsPublisher listMemoryRecordsPaginator(Consumer<ListMemoryRecordsRequest.Builder> listMemoryRecordsRequest)

      This is a variant of listMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsPublisher publisher = client.listMemoryRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListMemoryRecordsPublisher publisher = client.listMemoryRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListMemoryRecordsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentInstruments

      default CompletableFuture<ListPaymentInstrumentsResponse> listPaymentInstruments(ListPaymentInstrumentsRequest listPaymentInstrumentsRequest)

      List payment instruments for a manager.

      Parameters:
      listPaymentInstrumentsRequest - Request structure for listing payment instruments.
      Returns:
      A Java Future containing the result of the ListPaymentInstruments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentInstruments

      default CompletableFuture<ListPaymentInstrumentsResponse> listPaymentInstruments(Consumer<ListPaymentInstrumentsRequest.Builder> listPaymentInstrumentsRequest)

      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:
      A Java Future containing the result of the ListPaymentInstruments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentInstrumentsPaginator

      default ListPaymentInstrumentsPublisher listPaymentInstrumentsPaginator(ListPaymentInstrumentsRequest listPaymentInstrumentsRequest)

      This is a variant of listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsPublisher publisher = client.listPaymentInstrumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsPublisher publisher = client.listPaymentInstrumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentInstrumentsPaginator

      default ListPaymentInstrumentsPublisher listPaymentInstrumentsPaginator(Consumer<ListPaymentInstrumentsRequest.Builder> listPaymentInstrumentsRequest)

      This is a variant of listPaymentInstruments(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsPublisher publisher = client.listPaymentInstrumentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentInstrumentsPublisher publisher = client.listPaymentInstrumentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentInstrumentsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentSessions

      default CompletableFuture<ListPaymentSessionsResponse> listPaymentSessions(ListPaymentSessionsRequest listPaymentSessionsRequest)

      List payment sessions.

      Parameters:
      listPaymentSessionsRequest - Request structure for listing payment sessions.
      Returns:
      A Java Future containing the result of the ListPaymentSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentSessions

      default CompletableFuture<ListPaymentSessionsResponse> listPaymentSessions(Consumer<ListPaymentSessionsRequest.Builder> listPaymentSessionsRequest)

      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:
      A Java Future containing the result of the ListPaymentSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentSessionsPaginator

      default ListPaymentSessionsPublisher listPaymentSessionsPaginator(ListPaymentSessionsRequest listPaymentSessionsRequest)

      This is a variant of listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsPublisher publisher = client.listPaymentSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsPublisher publisher = client.listPaymentSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPaymentSessionsPaginator

      default ListPaymentSessionsPublisher listPaymentSessionsPaginator(Consumer<ListPaymentSessionsRequest.Builder> listPaymentSessionsRequest)

      This is a variant of listPaymentSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsPublisher publisher = client.listPaymentSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListPaymentSessionsPublisher publisher = client.listPaymentSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListPaymentSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommendations

      default CompletableFuture<ListRecommendationsResponse> listRecommendations(ListRecommendationsRequest listRecommendationsRequest)

      Lists all recommendations in the account, with optional filtering by status.

      Parameters:
      listRecommendationsRequest -
      Returns:
      A Java Future containing the result of the ListRecommendations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommendations

      default CompletableFuture<ListRecommendationsResponse> listRecommendations(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)

      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:
      A Java Future containing the result of the ListRecommendations operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommendationsPaginator

      default ListRecommendationsPublisher listRecommendationsPaginator(ListRecommendationsRequest listRecommendationsRequest)

      This is a variant of listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listRecommendationsPaginator

      default ListRecommendationsPublisher listRecommendationsPaginator(Consumer<ListRecommendationsRequest.Builder> listRecommendationsRequest)

      This is a variant of listRecommendations(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListRecommendationsPublisher publisher = client.listRecommendationsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListRecommendationsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSessions

      default CompletableFuture<ListSessionsResponse> listSessions(ListSessionsRequest listSessionsRequest)

      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:
      A Java Future containing the result of the ListSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSessions

      default CompletableFuture<ListSessionsResponse> listSessions(Consumer<ListSessionsRequest.Builder> listSessionsRequest)

      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:
      A Java Future containing the result of the ListSessions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSessionsPaginator

      default ListSessionsPublisher listSessionsPaginator(ListSessionsRequest listSessionsRequest)

      This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listSessionsPaginator

      default ListSessionsPublisher listSessionsPaginator(Consumer<ListSessionsRequest.Builder> listSessionsRequest)

      This is a variant of listSessions(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.ListSessionsPublisher publisher = client.listSessionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.ListSessionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • processPayment

      default CompletableFuture<ProcessPaymentResponse> processPayment(ProcessPaymentRequest processPaymentRequest)

      Processes a payment using a payment instrument within a payment session.

      Parameters:
      processPaymentRequest - Request structure for processing a payment.
      Returns:
      A Java Future containing the result of the ProcessPayment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • processPayment

      default CompletableFuture<ProcessPaymentResponse> processPayment(Consumer<ProcessPaymentRequest.Builder> processPaymentRequest)

      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:
      A Java Future containing the result of the ProcessPayment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • retrieveMemoryRecords

      default CompletableFuture<RetrieveMemoryRecordsResponse> retrieveMemoryRecords(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)

      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:
      A Java Future containing the result of the RetrieveMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • retrieveMemoryRecords

      default CompletableFuture<RetrieveMemoryRecordsResponse> retrieveMemoryRecords(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)

      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:
      A Java Future containing the result of the RetrieveMemoryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • retrieveMemoryRecordsPaginator

      default RetrieveMemoryRecordsPublisher retrieveMemoryRecordsPaginator(RetrieveMemoryRecordsRequest retrieveMemoryRecordsRequest)

      This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsPublisher publisher = client.retrieveMemoryRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsPublisher publisher = client.retrieveMemoryRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • retrieveMemoryRecordsPaginator

      default RetrieveMemoryRecordsPublisher retrieveMemoryRecordsPaginator(Consumer<RetrieveMemoryRecordsRequest.Builder> retrieveMemoryRecordsRequest)

      This is a variant of retrieveMemoryRecords(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsPublisher publisher = client.retrieveMemoryRecordsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagentcore.paginators.RetrieveMemoryRecordsPublisher publisher = client.retrieveMemoryRecordsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      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 publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • saveBrowserSessionProfile

      default CompletableFuture<SaveBrowserSessionProfileResponse> saveBrowserSessionProfile(SaveBrowserSessionProfileRequest saveBrowserSessionProfileRequest)

      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:

      Parameters:
      saveBrowserSessionProfileRequest -
      Returns:
      A Java Future containing the result of the SaveBrowserSessionProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • saveBrowserSessionProfile

      default CompletableFuture<SaveBrowserSessionProfileResponse> saveBrowserSessionProfile(Consumer<SaveBrowserSessionProfileRequest.Builder> saveBrowserSessionProfileRequest)

      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:


      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:
      A Java Future containing the result of the SaveBrowserSessionProfile operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchRegistryRecords

      default CompletableFuture<SearchRegistryRecordsResponse> searchRegistryRecords(SearchRegistryRecordsRequest searchRegistryRecordsRequest)

      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:
      A Java Future containing the result of the SearchRegistryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • searchRegistryRecords

      default CompletableFuture<SearchRegistryRecordsResponse> searchRegistryRecords(Consumer<SearchRegistryRecordsRequest.Builder> searchRegistryRecordsRequest)

      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:
      A Java Future containing the result of the SearchRegistryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startBatchEvaluation

      default CompletableFuture<StartBatchEvaluationResponse> startBatchEvaluation(StartBatchEvaluationRequest startBatchEvaluationRequest)

      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:
      A Java Future containing the result of the StartBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startBatchEvaluation

      default CompletableFuture<StartBatchEvaluationResponse> startBatchEvaluation(Consumer<StartBatchEvaluationRequest.Builder> startBatchEvaluationRequest)

      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:
      A Java Future containing the result of the StartBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startBrowserSession

      default CompletableFuture<StartBrowserSessionResponse> startBrowserSession(StartBrowserSessionRequest startBrowserSessionRequest)

      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:

      Parameters:
      startBrowserSessionRequest -
      Returns:
      A Java Future containing the result of the StartBrowserSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startBrowserSession

      default CompletableFuture<StartBrowserSessionResponse> startBrowserSession(Consumer<StartBrowserSessionRequest.Builder> startBrowserSessionRequest)

      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:


      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:
      A Java Future containing the result of the StartBrowserSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startCodeInterpreterSession

      default CompletableFuture<StartCodeInterpreterSessionResponse> startCodeInterpreterSession(StartCodeInterpreterSessionRequest startCodeInterpreterSessionRequest)

      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:

      Parameters:
      startCodeInterpreterSessionRequest -
      Returns:
      A Java Future containing the result of the StartCodeInterpreterSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startCodeInterpreterSession

      default CompletableFuture<StartCodeInterpreterSessionResponse> startCodeInterpreterSession(Consumer<StartCodeInterpreterSessionRequest.Builder> startCodeInterpreterSessionRequest)

      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:


      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:
      A Java Future containing the result of the StartCodeInterpreterSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startMemoryExtractionJob

      default CompletableFuture<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. 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:
      A Java Future containing the result of the StartMemoryExtractionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startMemoryExtractionJob

      default CompletableFuture<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. 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:
      A Java Future containing the result of the StartMemoryExtractionJob operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startRecommendation

      default CompletableFuture<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.

      Parameters:
      startRecommendationRequest -
      Returns:
      A Java Future containing the result of the StartRecommendation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • startRecommendation

      default CompletableFuture<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.


      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:
      A Java Future containing the result of the StartRecommendation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopBatchEvaluation

      default CompletableFuture<StopBatchEvaluationResponse> stopBatchEvaluation(StopBatchEvaluationRequest stopBatchEvaluationRequest)

      Stops a running batch evaluation. Sessions that have already been evaluated retain their results.

      Parameters:
      stopBatchEvaluationRequest -
      Returns:
      A Java Future containing the result of the StopBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopBatchEvaluation

      default CompletableFuture<StopBatchEvaluationResponse> stopBatchEvaluation(Consumer<StopBatchEvaluationRequest.Builder> stopBatchEvaluationRequest)

      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:
      A Java Future containing the result of the StopBatchEvaluation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopBrowserSession

      default CompletableFuture<StopBrowserSessionResponse> stopBrowserSession(StopBrowserSessionRequest stopBrowserSessionRequest)

      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:

      Parameters:
      stopBrowserSessionRequest -
      Returns:
      A Java Future containing the result of the StopBrowserSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopBrowserSession

      default CompletableFuture<StopBrowserSessionResponse> stopBrowserSession(Consumer<StopBrowserSessionRequest.Builder> stopBrowserSessionRequest)

      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:


      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:
      A Java Future containing the result of the StopBrowserSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopCodeInterpreterSession

      default CompletableFuture<StopCodeInterpreterSessionResponse> stopCodeInterpreterSession(StopCodeInterpreterSessionRequest stopCodeInterpreterSessionRequest)

      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:

      Parameters:
      stopCodeInterpreterSessionRequest -
      Returns:
      A Java Future containing the result of the StopCodeInterpreterSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopCodeInterpreterSession

      default CompletableFuture<StopCodeInterpreterSessionResponse> stopCodeInterpreterSession(Consumer<StopCodeInterpreterSessionRequest.Builder> stopCodeInterpreterSessionRequest)

      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:


      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:
      A Java Future containing the result of the StopCodeInterpreterSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopRuntimeSession

      default CompletableFuture<StopRuntimeSessionResponse> stopRuntimeSession(StopRuntimeSessionRequest stopRuntimeSessionRequest)

      Stops a session that is running in an running AgentCore Runtime agent.

      Parameters:
      stopRuntimeSessionRequest -
      Returns:
      A Java Future containing the result of the StopRuntimeSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • stopRuntimeSession

      default CompletableFuture<StopRuntimeSessionResponse> stopRuntimeSession(Consumer<StopRuntimeSessionRequest.Builder> stopRuntimeSessionRequest)

      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:
      A Java Future containing the result of the StopRuntimeSession operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateABTest

      default CompletableFuture<UpdateAbTestResponse> updateABTest(UpdateAbTestRequest updateAbTestRequest)

      Updates an A/B test's configuration, including variants, traffic allocation, evaluation settings, or execution status.

      Parameters:
      updateAbTestRequest -
      Returns:
      A Java Future containing the result of the UpdateABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateABTest

      default CompletableFuture<UpdateAbTestResponse> updateABTest(Consumer<UpdateAbTestRequest.Builder> updateAbTestRequest)

      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:
      A Java Future containing the result of the UpdateABTest operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateBrowserStream

      default CompletableFuture<UpdateBrowserStreamResponse> updateBrowserStream(UpdateBrowserStreamRequest updateBrowserStreamRequest)

      Updates a browser stream. To use this operation, you must have permissions to perform the bedrock:UpdateBrowserStream action.

      Parameters:
      updateBrowserStreamRequest -
      Returns:
      A Java Future containing the result of the UpdateBrowserStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateBrowserStream

      default CompletableFuture<UpdateBrowserStreamResponse> updateBrowserStream(Consumer<UpdateBrowserStreamRequest.Builder> updateBrowserStreamRequest)

      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:
      A Java Future containing the result of the UpdateBrowserStream operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • serviceClientConfiguration

      default BedrockAgentCoreServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static BedrockAgentCoreAsyncClient create()
      Create a BedrockAgentCoreAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BedrockAgentCoreAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BedrockAgentCoreAsyncClient.