Package software.amazon.awssdk.services.bedrockagent

Interface BedrockAgentAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BedrockAgentAsyncClient extends AwsClient
Service client for accessing Agents for Amazon Bedrock 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.

Describes the API operations for creating and managing Amazon Bedrock agents.

  • Field Details

  • Method Details

    • associateAgentKnowledgeBase

      default CompletableFuture<AssociateAgentKnowledgeBaseResponse> associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)

      Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

      Parameters:
      associateAgentKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the AssociateAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • associateAgentKnowledgeBase

      default CompletableFuture<AssociateAgentKnowledgeBaseResponse> associateAgentKnowledgeBase(Consumer<AssociateAgentKnowledgeBaseRequest.Builder> associateAgentKnowledgeBaseRequest)

      Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.


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

      Parameters:
      associateAgentKnowledgeBaseRequest - A Consumer that will call methods on AssociateAgentKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AssociateAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgent

      default CompletableFuture<CreateAgentResponse> createAgent(CreateAgentRequest createAgentRequest)

      Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

      • Specify the following fields for security purposes.

        • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

        • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

        • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

      • To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

      • If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

      Parameters:
      createAgentRequest -
      Returns:
      A Java Future containing the result of the CreateAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgent

      default CompletableFuture<CreateAgentResponse> createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest)

      Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

      • Specify the following fields for security purposes.

        • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

        • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

        • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

      • To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.

      • If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.


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

      Parameters:
      createAgentRequest - A Consumer that will call methods on CreateAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgentActionGroup

      default CompletableFuture<CreateAgentActionGroupResponse> createAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest)

      Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

      To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.

      Parameters:
      createAgentActionGroupRequest -
      Returns:
      A Java Future containing the result of the CreateAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgentActionGroup

      default CompletableFuture<CreateAgentActionGroupResponse> createAgentActionGroup(Consumer<CreateAgentActionGroupRequest.Builder> createAgentActionGroupRequest)

      Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

      To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput. You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.


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

      Parameters:
      createAgentActionGroupRequest - A Consumer that will call methods on CreateAgentActionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgentAlias

      default CompletableFuture<CreateAgentAliasResponse> createAgentAlias(CreateAgentAliasRequest createAgentAliasRequest)

      Creates an alias of an agent that can be used to deploy the agent.

      Parameters:
      createAgentAliasRequest -
      Returns:
      A Java Future containing the result of the CreateAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createAgentAlias

      default CompletableFuture<CreateAgentAliasResponse> createAgentAlias(Consumer<CreateAgentAliasRequest.Builder> createAgentAliasRequest)

      Creates an alias of an agent that can be used to deploy the agent.


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

      Parameters:
      createAgentAliasRequest - A Consumer that will call methods on CreateAgentAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataSource

      default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest)

      Sets up a data source to be added to a knowledge base.

      You can't change the chunkingConfiguration after you create the data source.

      Parameters:
      createDataSourceRequest -
      Returns:
      A Java Future containing the result of the CreateDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createDataSource

      default CompletableFuture<CreateDataSourceResponse> createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)

      Sets up a data source to be added to a knowledge base.

      You can't change the chunkingConfiguration after you create the data source.


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

      Parameters:
      createDataSourceRequest - A Consumer that will call methods on CreateDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createKnowledgeBase

      default CompletableFuture<CreateKnowledgeBaseResponse> createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)

      Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.

      If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.

      • Provide the name and an optional description.

      • Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

      • Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

      • Provide the configuration for your vector store in the storageConfiguration object.

      Parameters:
      createKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the CreateKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createKnowledgeBase

      default CompletableFuture<CreateKnowledgeBaseResponse> createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest)

      Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.

      If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.

      • Provide the name and an optional description.

      • Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.

      • Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.

      • Provide the configuration for your vector store in the storageConfiguration object.


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

      Parameters:
      createKnowledgeBaseRequest - A Consumer that will call methods on CreateKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgent

      default CompletableFuture<DeleteAgentResponse> deleteAgent(DeleteAgentRequest deleteAgentRequest)

      Deletes an agent.

      Parameters:
      deleteAgentRequest -
      Returns:
      A Java Future containing the result of the DeleteAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgent

      default CompletableFuture<DeleteAgentResponse> deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)

      Deletes an agent.


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

      Parameters:
      deleteAgentRequest - A Consumer that will call methods on DeleteAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgentActionGroup

      default CompletableFuture<DeleteAgentActionGroupResponse> deleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest)

      Deletes an action group in an agent.

      Parameters:
      deleteAgentActionGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgentActionGroup

      default CompletableFuture<DeleteAgentActionGroupResponse> deleteAgentActionGroup(Consumer<DeleteAgentActionGroupRequest.Builder> deleteAgentActionGroupRequest)

      Deletes an action group in an agent.


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

      Parameters:
      deleteAgentActionGroupRequest - A Consumer that will call methods on DeleteAgentActionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgentAlias

      default CompletableFuture<DeleteAgentAliasResponse> deleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest)

      Deletes an alias of an agent.

      Parameters:
      deleteAgentAliasRequest -
      Returns:
      A Java Future containing the result of the DeleteAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgentAlias

      default CompletableFuture<DeleteAgentAliasResponse> deleteAgentAlias(Consumer<DeleteAgentAliasRequest.Builder> deleteAgentAliasRequest)

      Deletes an alias of an agent.


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

      Parameters:
      deleteAgentAliasRequest - A Consumer that will call methods on DeleteAgentAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgentVersion

      default CompletableFuture<DeleteAgentVersionResponse> deleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest)

      Deletes a version of an agent.

      Parameters:
      deleteAgentVersionRequest -
      Returns:
      A Java Future containing the result of the DeleteAgentVersion 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteAgentVersion

      default CompletableFuture<DeleteAgentVersionResponse> deleteAgentVersion(Consumer<DeleteAgentVersionRequest.Builder> deleteAgentVersionRequest)

      Deletes a version of an agent.


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

      Parameters:
      deleteAgentVersionRequest - A Consumer that will call methods on DeleteAgentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteAgentVersion 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataSource

      default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

      Deletes a data source from a knowledge base.

      Parameters:
      deleteDataSourceRequest -
      Returns:
      A Java Future containing the result of the DeleteDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteDataSource

      default CompletableFuture<DeleteDataSourceResponse> deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)

      Deletes a data source from a knowledge base.


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

      Parameters:
      deleteDataSourceRequest - A Consumer that will call methods on DeleteDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKnowledgeBase

      default CompletableFuture<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)

      Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.

      Parameters:
      deleteKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the DeleteKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteKnowledgeBase

      default CompletableFuture<DeleteKnowledgeBaseResponse> deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest)

      Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.


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

      Parameters:
      deleteKnowledgeBaseRequest - A Consumer that will call methods on DeleteKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateAgentKnowledgeBase

      default CompletableFuture<DisassociateAgentKnowledgeBaseResponse> disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest)

      Disassociates a knowledge base from an agent.

      Parameters:
      disassociateAgentKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the DisassociateAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • disassociateAgentKnowledgeBase

      default CompletableFuture<DisassociateAgentKnowledgeBaseResponse> disassociateAgentKnowledgeBase(Consumer<DisassociateAgentKnowledgeBaseRequest.Builder> disassociateAgentKnowledgeBaseRequest)

      Disassociates a knowledge base from an agent.


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

      Parameters:
      disassociateAgentKnowledgeBaseRequest - A Consumer that will call methods on DisassociateAgentKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DisassociateAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgent

      default CompletableFuture<GetAgentResponse> getAgent(GetAgentRequest getAgentRequest)

      Gets information about an agent.

      Parameters:
      getAgentRequest -
      Returns:
      A Java Future containing the result of the GetAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgent

      default CompletableFuture<GetAgentResponse> getAgent(Consumer<GetAgentRequest.Builder> getAgentRequest)

      Gets information about an agent.


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

      Parameters:
      getAgentRequest - A Consumer that will call methods on GetAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentActionGroup

      default CompletableFuture<GetAgentActionGroupResponse> getAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest)

      Gets information about an action group for an agent.

      Parameters:
      getAgentActionGroupRequest -
      Returns:
      A Java Future containing the result of the GetAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentActionGroup

      default CompletableFuture<GetAgentActionGroupResponse> getAgentActionGroup(Consumer<GetAgentActionGroupRequest.Builder> getAgentActionGroupRequest)

      Gets information about an action group for an agent.


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

      Parameters:
      getAgentActionGroupRequest - A Consumer that will call methods on GetAgentActionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentAlias

      default CompletableFuture<GetAgentAliasResponse> getAgentAlias(GetAgentAliasRequest getAgentAliasRequest)

      Gets information about an alias of an agent.

      Parameters:
      getAgentAliasRequest -
      Returns:
      A Java Future containing the result of the GetAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentAlias

      default CompletableFuture<GetAgentAliasResponse> getAgentAlias(Consumer<GetAgentAliasRequest.Builder> getAgentAliasRequest)

      Gets information about an alias of an agent.


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

      Parameters:
      getAgentAliasRequest - A Consumer that will call methods on GetAgentAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentKnowledgeBase

      default CompletableFuture<GetAgentKnowledgeBaseResponse> getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest)

      Gets information about a knowledge base associated with an agent.

      Parameters:
      getAgentKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the GetAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentKnowledgeBase

      default CompletableFuture<GetAgentKnowledgeBaseResponse> getAgentKnowledgeBase(Consumer<GetAgentKnowledgeBaseRequest.Builder> getAgentKnowledgeBaseRequest)

      Gets information about a knowledge base associated with an agent.


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

      Parameters:
      getAgentKnowledgeBaseRequest - A Consumer that will call methods on GetAgentKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentVersion

      default CompletableFuture<GetAgentVersionResponse> getAgentVersion(GetAgentVersionRequest getAgentVersionRequest)

      Gets details about a version of an agent.

      Parameters:
      getAgentVersionRequest -
      Returns:
      A Java Future containing the result of the GetAgentVersion 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getAgentVersion

      default CompletableFuture<GetAgentVersionResponse> getAgentVersion(Consumer<GetAgentVersionRequest.Builder> getAgentVersionRequest)

      Gets details about a version of an agent.


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

      Parameters:
      getAgentVersionRequest - A Consumer that will call methods on GetAgentVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetAgentVersion 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataSource

      default CompletableFuture<GetDataSourceResponse> getDataSource(GetDataSourceRequest getDataSourceRequest)

      Gets information about a data source.

      Parameters:
      getDataSourceRequest -
      Returns:
      A Java Future containing the result of the GetDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDataSource

      default CompletableFuture<GetDataSourceResponse> getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest)

      Gets information about a data source.


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

      Parameters:
      getDataSourceRequest - A Consumer that will call methods on GetDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIngestionJob

      default CompletableFuture<GetIngestionJobResponse> getIngestionJob(GetIngestionJobRequest getIngestionJobRequest)

      Gets information about a ingestion job, in which a data source is added to a knowledge base.

      Parameters:
      getIngestionJobRequest -
      Returns:
      A Java Future containing the result of the GetIngestionJob 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIngestionJob

      default CompletableFuture<GetIngestionJobResponse> getIngestionJob(Consumer<GetIngestionJobRequest.Builder> getIngestionJobRequest)

      Gets information about a ingestion job, in which a data source is added to a knowledge base.


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

      Parameters:
      getIngestionJobRequest - A Consumer that will call methods on GetIngestionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIngestionJob 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKnowledgeBase

      default CompletableFuture<GetKnowledgeBaseResponse> getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)

      Gets information about a knoweldge base.

      Parameters:
      getKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the GetKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getKnowledgeBase

      default CompletableFuture<GetKnowledgeBaseResponse> getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest)

      Gets information about a knoweldge base.


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

      Parameters:
      getKnowledgeBaseRequest - A Consumer that will call methods on GetKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentActionGroups

      default CompletableFuture<ListAgentActionGroupsResponse> listAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest)

      Lists the action groups for an agent and information about each one.

      Parameters:
      listAgentActionGroupsRequest -
      Returns:
      A Java Future containing the result of the ListAgentActionGroups 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentActionGroups

      default CompletableFuture<ListAgentActionGroupsResponse> listAgentActionGroups(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest)

      Lists the action groups for an agent and information about each one.


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

      Parameters:
      listAgentActionGroupsRequest - A Consumer that will call methods on ListAgentActionGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgentActionGroups 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentActionGroupsPaginator

      default ListAgentActionGroupsPublisher listAgentActionGroupsPaginator(ListAgentActionGroupsRequest listAgentActionGroupsRequest)

      This is a variant of listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest) 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.bedrockagent.paginators.ListAgentActionGroupsPublisher publisher = client.listAgentActionGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsPublisher publisher = client.listAgentActionGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsResponse 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 listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest) operation.

      Parameters:
      listAgentActionGroupsRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentActionGroupsPaginator

      default ListAgentActionGroupsPublisher listAgentActionGroupsPaginator(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest)

      This is a variant of listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest) 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.bedrockagent.paginators.ListAgentActionGroupsPublisher publisher = client.listAgentActionGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsPublisher publisher = client.listAgentActionGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsResponse 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 listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest) operation.


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

      Parameters:
      listAgentActionGroupsRequest - A Consumer that will call methods on ListAgentActionGroupsRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentAliases

      default CompletableFuture<ListAgentAliasesResponse> listAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest)

      Lists the aliases of an agent and information about each one.

      Parameters:
      listAgentAliasesRequest -
      Returns:
      A Java Future containing the result of the ListAgentAliases 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentAliases

      default CompletableFuture<ListAgentAliasesResponse> listAgentAliases(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest)

      Lists the aliases of an agent and information about each one.


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

      Parameters:
      listAgentAliasesRequest - A Consumer that will call methods on ListAgentAliasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgentAliases 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentAliasesPaginator

      default ListAgentAliasesPublisher listAgentAliasesPaginator(ListAgentAliasesRequest listAgentAliasesRequest)

      This is a variant of listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest) 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.bedrockagent.paginators.ListAgentAliasesPublisher publisher = client.listAgentAliasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesPublisher publisher = client.listAgentAliasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesResponse 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 listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest) operation.

      Parameters:
      listAgentAliasesRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentAliasesPaginator

      default ListAgentAliasesPublisher listAgentAliasesPaginator(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest)

      This is a variant of listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest) 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.bedrockagent.paginators.ListAgentAliasesPublisher publisher = client.listAgentAliasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesPublisher publisher = client.listAgentAliasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesResponse 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 listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest) operation.


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

      Parameters:
      listAgentAliasesRequest - A Consumer that will call methods on ListAgentAliasesRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentKnowledgeBases

      default CompletableFuture<ListAgentKnowledgeBasesResponse> listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)

      Lists knowledge bases associated with an agent and information about each one.

      Parameters:
      listAgentKnowledgeBasesRequest -
      Returns:
      A Java Future containing the result of the ListAgentKnowledgeBases 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentKnowledgeBases

      default CompletableFuture<ListAgentKnowledgeBasesResponse> listAgentKnowledgeBases(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest)

      Lists knowledge bases associated with an agent and information about each one.


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

      Parameters:
      listAgentKnowledgeBasesRequest - A Consumer that will call methods on ListAgentKnowledgeBasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgentKnowledgeBases 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentKnowledgeBasesPaginator

      default ListAgentKnowledgeBasesPublisher listAgentKnowledgeBasesPaginator(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)

      This is a variant of listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest) 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.bedrockagent.paginators.ListAgentKnowledgeBasesPublisher publisher = client.listAgentKnowledgeBasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesPublisher publisher = client.listAgentKnowledgeBasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesResponse 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 listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest) operation.

      Parameters:
      listAgentKnowledgeBasesRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentKnowledgeBasesPaginator

      default ListAgentKnowledgeBasesPublisher listAgentKnowledgeBasesPaginator(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest)

      This is a variant of listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest) 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.bedrockagent.paginators.ListAgentKnowledgeBasesPublisher publisher = client.listAgentKnowledgeBasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesPublisher publisher = client.listAgentKnowledgeBasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesResponse 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 listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest) operation.


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

      Parameters:
      listAgentKnowledgeBasesRequest - A Consumer that will call methods on ListAgentKnowledgeBasesRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentVersions

      default CompletableFuture<ListAgentVersionsResponse> listAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest)

      Lists the versions of an agent and information about each version.

      Parameters:
      listAgentVersionsRequest -
      Returns:
      A Java Future containing the result of the ListAgentVersions 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentVersions

      default CompletableFuture<ListAgentVersionsResponse> listAgentVersions(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest)

      Lists the versions of an agent and information about each version.


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

      Parameters:
      listAgentVersionsRequest - A Consumer that will call methods on ListAgentVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgentVersions 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentVersionsPaginator

      default ListAgentVersionsPublisher listAgentVersionsPaginator(ListAgentVersionsRequest listAgentVersionsRequest)

      This is a variant of listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest) 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.bedrockagent.paginators.ListAgentVersionsPublisher publisher = client.listAgentVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsPublisher publisher = client.listAgentVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsResponse 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 listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest) operation.

      Parameters:
      listAgentVersionsRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentVersionsPaginator

      default ListAgentVersionsPublisher listAgentVersionsPaginator(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest)

      This is a variant of listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest) 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.bedrockagent.paginators.ListAgentVersionsPublisher publisher = client.listAgentVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsPublisher publisher = client.listAgentVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsResponse 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 listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest) operation.


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

      Parameters:
      listAgentVersionsRequest - A Consumer that will call methods on ListAgentVersionsRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgents

      default CompletableFuture<ListAgentsResponse> listAgents(ListAgentsRequest listAgentsRequest)

      Lists the agents belonging to an account and information about each agent.

      Parameters:
      listAgentsRequest -
      Returns:
      A Java Future containing the result of the ListAgents 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgents

      default CompletableFuture<ListAgentsResponse> listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)

      Lists the agents belonging to an account and information about each agent.


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

      Parameters:
      listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAgents 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentsPaginator

      default ListAgentsPublisher listAgentsPaginator(ListAgentsRequest listAgentsRequest)

      This is a variant of listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest) 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.bedrockagent.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentsResponse 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 listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest) operation.

      Parameters:
      listAgentsRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAgentsPaginator

      default ListAgentsPublisher listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)

      This is a variant of listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest) 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.bedrockagent.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListAgentsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListAgentsResponse 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 listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest) operation.


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

      Parameters:
      listAgentsRequest - A Consumer that will call methods on ListAgentsRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSources

      default CompletableFuture<ListDataSourcesResponse> listDataSources(ListDataSourcesRequest listDataSourcesRequest)

      Lists the data sources in a knowledge base and information about each one.

      Parameters:
      listDataSourcesRequest -
      Returns:
      A Java Future containing the result of the ListDataSources 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSources

      default CompletableFuture<ListDataSourcesResponse> listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)

      Lists the data sources in a knowledge base and information about each one.


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

      Parameters:
      listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListDataSources 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourcesPaginator

      default ListDataSourcesPublisher listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)

      This is a variant of listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest) 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.bedrockagent.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesResponse 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 listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest) operation.

      Parameters:
      listDataSourcesRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listDataSourcesPaginator

      default ListDataSourcesPublisher listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)

      This is a variant of listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest) 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.bedrockagent.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesResponse 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 listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest) operation.


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

      Parameters:
      listDataSourcesRequest - A Consumer that will call methods on ListDataSourcesRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIngestionJobs

      default CompletableFuture<ListIngestionJobsResponse> listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest)

      Lists the ingestion jobs for a data source and information about each of them.

      Parameters:
      listIngestionJobsRequest -
      Returns:
      A Java Future containing the result of the ListIngestionJobs 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIngestionJobs

      default CompletableFuture<ListIngestionJobsResponse> listIngestionJobs(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest)

      Lists the ingestion jobs for a data source and information about each of them.


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

      Parameters:
      listIngestionJobsRequest - A Consumer that will call methods on ListIngestionJobsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListIngestionJobs 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIngestionJobsPaginator

      default ListIngestionJobsPublisher listIngestionJobsPaginator(ListIngestionJobsRequest listIngestionJobsRequest)

      This is a variant of listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest) 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.bedrockagent.paginators.ListIngestionJobsPublisher publisher = client.listIngestionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsPublisher publisher = client.listIngestionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsResponse 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 listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest) operation.

      Parameters:
      listIngestionJobsRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listIngestionJobsPaginator

      default ListIngestionJobsPublisher listIngestionJobsPaginator(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest)

      This is a variant of listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest) 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.bedrockagent.paginators.ListIngestionJobsPublisher publisher = client.listIngestionJobsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsPublisher publisher = client.listIngestionJobsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsResponse 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 listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest) operation.


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

      Parameters:
      listIngestionJobsRequest - A Consumer that will call methods on ListIngestionJobsRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBases

      default CompletableFuture<ListKnowledgeBasesResponse> listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)

      Lists the knowledge bases in an account and information about each of them.

      Parameters:
      listKnowledgeBasesRequest -
      Returns:
      A Java Future containing the result of the ListKnowledgeBases 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBases

      default CompletableFuture<ListKnowledgeBasesResponse> listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)

      Lists the knowledge bases in an account and information about each of them.


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

      Parameters:
      listKnowledgeBasesRequest - A Consumer that will call methods on ListKnowledgeBasesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListKnowledgeBases 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBasesPaginator

      default ListKnowledgeBasesPublisher listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest)

      This is a variant of listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest) 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.bedrockagent.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesResponse 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 listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest) operation.

      Parameters:
      listKnowledgeBasesRequest -
      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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listKnowledgeBasesPaginator

      default ListKnowledgeBasesPublisher listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)

      This is a variant of listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest) 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.bedrockagent.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesResponse 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 listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest) operation.


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

      Parameters:
      listKnowledgeBasesRequest - A Consumer that will call methods on ListKnowledgeBasesRequest.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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      List all the tags for the resource you specify.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      List all the tags for the resource you specify.


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

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • prepareAgent

      default CompletableFuture<PrepareAgentResponse> prepareAgent(PrepareAgentRequest prepareAgentRequest)

      Creates a DRAFT version of the agent that can be used for internal testing.

      Parameters:
      prepareAgentRequest -
      Returns:
      A Java Future containing the result of the PrepareAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • prepareAgent

      default CompletableFuture<PrepareAgentResponse> prepareAgent(Consumer<PrepareAgentRequest.Builder> prepareAgentRequest)

      Creates a DRAFT version of the agent that can be used for internal testing.


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

      Parameters:
      prepareAgentRequest - A Consumer that will call methods on PrepareAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PrepareAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startIngestionJob

      default CompletableFuture<StartIngestionJobResponse> startIngestionJob(StartIngestionJobRequest startIngestionJobRequest)

      Begins an ingestion job, in which a data source is added to a knowledge base.

      Parameters:
      startIngestionJobRequest -
      Returns:
      A Java Future containing the result of the StartIngestionJob 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startIngestionJob

      default CompletableFuture<StartIngestionJobResponse> startIngestionJob(Consumer<StartIngestionJobRequest.Builder> startIngestionJobRequest)

      Begins an ingestion job, in which a data source is added to a knowledge base.


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

      Parameters:
      startIngestionJobRequest - A Consumer that will call methods on StartIngestionJobRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartIngestionJob 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

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

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

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


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

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Remove tags from a resource.

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Remove tags from a resource.


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

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgent

      default CompletableFuture<UpdateAgentResponse> updateAgent(UpdateAgentRequest updateAgentRequest)

      Updates the configuration of an agent.

      Parameters:
      updateAgentRequest -
      Returns:
      A Java Future containing the result of the UpdateAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgent

      default CompletableFuture<UpdateAgentResponse> updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)

      Updates the configuration of an agent.


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

      Parameters:
      updateAgentRequest - A Consumer that will call methods on UpdateAgentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAgent 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentActionGroup

      default CompletableFuture<UpdateAgentActionGroupResponse> updateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest)

      Updates the configuration for an action group for an agent.

      Parameters:
      updateAgentActionGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentActionGroup

      default CompletableFuture<UpdateAgentActionGroupResponse> updateAgentActionGroup(Consumer<UpdateAgentActionGroupRequest.Builder> updateAgentActionGroupRequest)

      Updates the configuration for an action group for an agent.


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

      Parameters:
      updateAgentActionGroupRequest - A Consumer that will call methods on UpdateAgentActionGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAgentActionGroup 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentAlias

      default CompletableFuture<UpdateAgentAliasResponse> updateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest)

      Updates configurations for an alias of an agent.

      Parameters:
      updateAgentAliasRequest -
      Returns:
      A Java Future containing the result of the UpdateAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentAlias

      default CompletableFuture<UpdateAgentAliasResponse> updateAgentAlias(Consumer<UpdateAgentAliasRequest.Builder> updateAgentAliasRequest)

      Updates configurations for an alias of an agent.


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

      Parameters:
      updateAgentAliasRequest - A Consumer that will call methods on UpdateAgentAliasRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAgentAlias 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentKnowledgeBase

      default CompletableFuture<UpdateAgentKnowledgeBaseResponse> updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest)

      Updates the configuration for a knowledge base that has been associated with an agent.

      Parameters:
      updateAgentKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the UpdateAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateAgentKnowledgeBase

      default CompletableFuture<UpdateAgentKnowledgeBaseResponse> updateAgentKnowledgeBase(Consumer<UpdateAgentKnowledgeBaseRequest.Builder> updateAgentKnowledgeBaseRequest)

      Updates the configuration for a knowledge base that has been associated with an agent.


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

      Parameters:
      updateAgentKnowledgeBaseRequest - A Consumer that will call methods on UpdateAgentKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateAgentKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataSource

      default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

      Updates configurations for a data source.

      You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.

      Parameters:
      updateDataSourceRequest -
      Returns:
      A Java Future containing the result of the UpdateDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateDataSource

      default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)

      Updates configurations for a data source.

      You can't change the chunkingConfiguration after you create the data source. Specify the existing chunkingConfiguration.


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

      Parameters:
      updateDataSourceRequest - A Consumer that will call methods on UpdateDataSourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateDataSource 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateKnowledgeBase

      default CompletableFuture<UpdateKnowledgeBaseResponse> updateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest)

      Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

      You can change the following fields:

      • name

      • description

      • roleArn

      You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.

      Parameters:
      updateKnowledgeBaseRequest -
      Returns:
      A Java Future containing the result of the UpdateKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateKnowledgeBase

      default CompletableFuture<UpdateKnowledgeBaseResponse> updateKnowledgeBase(Consumer<UpdateKnowledgeBaseRequest.Builder> updateKnowledgeBaseRequest)

      Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

      You can change the following fields:

      • name

      • description

      • roleArn

      You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.


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

      Parameters:
      updateKnowledgeBaseRequest - A Consumer that will call methods on UpdateKnowledgeBaseRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateKnowledgeBase 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.
      • ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
      • AccessDeniedException The request is denied because of missing access permissions.
      • ValidationException Input validation failed. Check your request parameters and retry the request.
      • InternalServerException An internal server error occurred. Retry your request.
      • ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
      • ConflictException There was a conflict performing an operation.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • BedrockAgentException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default BedrockAgentServiceClientConfiguration 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 BedrockAgentAsyncClient create()
      Create a BedrockAgentAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static BedrockAgentAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a BedrockAgentAsyncClient.