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 staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported 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 Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
associateAgentKnowledgeBase
default CompletableFuture<AssociateAgentKnowledgeBaseResponse> associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)
Associates a knowledge base with an agent. If a knowledge base is associated and its
indexStateis set toEnabled, 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 invokeThrowable.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:
- AWS API Documentation
-
associateAgentKnowledgeBase
default CompletableFuture<AssociateAgentKnowledgeBaseResponse> associateAgentKnowledgeBase(Consumer<AssociateAgentKnowledgeBaseRequest.Builder> associateAgentKnowledgeBaseRequest)
Associates a knowledge base with an agent. If a knowledge base is associated and its
indexStateis set toEnabled, 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.Builderavoiding the need to create one manually viaAssociateAgentKnowledgeBaseRequest.builder()- Parameters:
associateAgentKnowledgeBaseRequest- AConsumerthat will call methods onAssociateAgentKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 subsequentInvokeAgentrequest begins a new session.
-
-
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfigurationobject. For more information, see Advanced prompts. -
If you agent fails to be created, the response returns a list of
failureReasonsalongside a list ofrecommendedActionsfor 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 invokeThrowable.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:
- AWS API Documentation
-
-
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 subsequentInvokeAgentrequest begins a new session.
-
-
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfigurationobject. For more information, see Advanced prompts. -
If you agent fails to be created, the response returns a list of
failureReasonsalongside a list ofrecommendedActionsfor you to troubleshoot.
This is a convenience which creates an instance of the
CreateAgentRequest.Builderavoiding the need to create one manually viaCreateAgentRequest.builder()- Parameters:
createAgentRequest- AConsumerthat will call methods onCreateAgentRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
-
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
parentActionGroupSignaturefield set toAMAZON.UserInput. You must leave thedescription,apiSchema, andactionGroupExecutorfields 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 invokeThrowable.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:
- AWS API Documentation
-
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
parentActionGroupSignaturefield set toAMAZON.UserInput. You must leave thedescription,apiSchema, andactionGroupExecutorfields 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.Builderavoiding the need to create one manually viaCreateAgentActionGroupRequest.builder()- Parameters:
createAgentActionGroupRequest- AConsumerthat will call methods onCreateAgentActionGroupRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaCreateAgentAliasRequest.builder()- Parameters:
createAgentAliasRequest- AConsumerthat will call methods onCreateAgentAliasRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
createDataSource
default CompletableFuture<CreateDataSourceResponse> createDataSource(CreateDataSourceRequest createDataSourceRequest)
Sets up a data source to be added to a knowledge base.
You can't change the
chunkingConfigurationafter 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 invokeThrowable.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:
- AWS API Documentation
-
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
chunkingConfigurationafter you create the data source.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builderavoiding the need to create one manually viaCreateDataSourceRequest.builder()- Parameters:
createDataSourceRequest- AConsumerthat will call methods onCreateDataSourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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
nameand an optionaldescription. -
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the
roleArnfield. -
Provide the embedding model to use in the
embeddingModelArnfield in theknowledgeBaseConfigurationobject. -
Provide the configuration for your vector store in the
storageConfigurationobject.-
For an Amazon OpenSearch Service database, use the
opensearchServerlessConfigurationobject. For more information, see Create a vector store in Amazon OpenSearch Service. -
For an Amazon Aurora database, use the
RdsConfigurationobject. For more information, see Create a vector store in Amazon Aurora. -
For a Pinecone database, use the
pineconeConfigurationobject. For more information, see Create a vector store in Pinecone. -
For a Redis Enterprise Cloud database, use the
redisEnterpriseCloudConfigurationobject. For more information, see Create a vector store in Redis Enterprise Cloud.
-
- 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 invokeThrowable.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:
- AWS API Documentation
-
-
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
nameand an optionaldescription. -
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the
roleArnfield. -
Provide the embedding model to use in the
embeddingModelArnfield in theknowledgeBaseConfigurationobject. -
Provide the configuration for your vector store in the
storageConfigurationobject.-
For an Amazon OpenSearch Service database, use the
opensearchServerlessConfigurationobject. For more information, see Create a vector store in Amazon OpenSearch Service. -
For an Amazon Aurora database, use the
RdsConfigurationobject. For more information, see Create a vector store in Amazon Aurora. -
For a Pinecone database, use the
pineconeConfigurationobject. For more information, see Create a vector store in Pinecone. -
For a Redis Enterprise Cloud database, use the
redisEnterpriseCloudConfigurationobject. For more information, see Create a vector store in Redis Enterprise Cloud.
-
This is a convenience which creates an instance of the
CreateKnowledgeBaseRequest.Builderavoiding the need to create one manually viaCreateKnowledgeBaseRequest.builder()- Parameters:
createKnowledgeBaseRequest- AConsumerthat will call methods onCreateKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
-
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 invokeThrowable.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:
- AWS API Documentation
-
deleteAgent
default CompletableFuture<DeleteAgentResponse> deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)
Deletes an agent.
This is a convenience which creates an instance of the
DeleteAgentRequest.Builderavoiding the need to create one manually viaDeleteAgentRequest.builder()- Parameters:
deleteAgentRequest- AConsumerthat will call methods onDeleteAgentRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAgentActionGroupRequest.builder()- Parameters:
deleteAgentActionGroupRequest- AConsumerthat will call methods onDeleteAgentActionGroupRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAgentAliasRequest.builder()- Parameters:
deleteAgentAliasRequest- AConsumerthat will call methods onDeleteAgentAliasRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteAgentVersionRequest.builder()- Parameters:
deleteAgentVersionRequest- AConsumerthat will call methods onDeleteAgentVersionRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()- Parameters:
deleteKnowledgeBaseRequest- AConsumerthat will call methods onDeleteKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaDisassociateAgentKnowledgeBaseRequest.builder()- Parameters:
disassociateAgentKnowledgeBaseRequest- AConsumerthat will call methods onDisassociateAgentKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAgentRequest.builder()- Parameters:
getAgentRequest- AConsumerthat will call methods onGetAgentRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAgentActionGroupRequest.builder()- Parameters:
getAgentActionGroupRequest- AConsumerthat will call methods onGetAgentActionGroupRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAgentAliasRequest.builder()- Parameters:
getAgentAliasRequest- AConsumerthat will call methods onGetAgentAliasRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAgentKnowledgeBaseRequest.builder()- Parameters:
getAgentKnowledgeBaseRequest- AConsumerthat will call methods onGetAgentKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetAgentVersionRequest.builder()- Parameters:
getAgentVersionRequest- AConsumerthat will call methods onGetAgentVersionRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetDataSourceRequest.builder()- Parameters:
getDataSourceRequest- AConsumerthat will call methods onGetDataSourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetIngestionJobRequest.builder()- Parameters:
getIngestionJobRequest- AConsumerthat will call methods onGetIngestionJobRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()- Parameters:
getKnowledgeBaseRequest- AConsumerthat will call methods onGetKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAgentActionGroupsRequest.builder()- Parameters:
listAgentActionGroupsRequest- AConsumerthat will call methods onListAgentActionGroupsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsPublisher publisher = client.listAgentActionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsPublisher publisher = client.listAgentActionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAgentActionGroupsRequest.builder()- Parameters:
listAgentActionGroupsRequest- AConsumerthat will call methods onListAgentActionGroupsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAgentAliasesRequest.builder()- Parameters:
listAgentAliasesRequest- AConsumerthat will call methods onListAgentAliasesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesPublisher publisher = client.listAgentAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesPublisher publisher = client.listAgentAliasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAgentAliasesRequest.builder()- Parameters:
listAgentAliasesRequest- AConsumerthat will call methods onListAgentAliasesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAgentKnowledgeBasesRequest.builder()- Parameters:
listAgentKnowledgeBasesRequest- AConsumerthat will call methods onListAgentKnowledgeBasesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesPublisher publisher = client.listAgentKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesPublisher publisher = client.listAgentKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAgentKnowledgeBasesRequest.builder()- Parameters:
listAgentKnowledgeBasesRequest- AConsumerthat will call methods onListAgentKnowledgeBasesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAgentVersionsRequest.builder()- Parameters:
listAgentVersionsRequest- AConsumerthat will call methods onListAgentVersionsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsPublisher publisher = client.listAgentVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsPublisher publisher = client.listAgentVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAgentVersionsRequest.builder()- Parameters:
listAgentVersionsRequest- AConsumerthat will call methods onListAgentVersionsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListAgentsRequest.builder()- Parameters:
listAgentsRequest- AConsumerthat will call methods onListAgentsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentsPublisher publisher = client.listAgentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListAgentsRequest.builder()- Parameters:
listAgentsRequest- AConsumerthat will call methods onListAgentsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesPublisher publisher = client.listDataSourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListIngestionJobsRequest.builder()- Parameters:
listIngestionJobsRequest- AConsumerthat will call methods onListIngestionJobsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsPublisher publisher = client.listIngestionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsPublisher publisher = client.listIngestionJobsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListIngestionJobsRequest.builder()- Parameters:
listIngestionJobsRequest- AConsumerthat will call methods onListIngestionJobsRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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 invokeThrowable.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:
- AWS API Documentation
-
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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesPublisher publisher = client.listKnowledgeBasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.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) { //... }; });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.Builderavoiding the need to create one manually viaListKnowledgeBasesRequest.builder()- Parameters:
listKnowledgeBasesRequest- AConsumerthat will call methods onListKnowledgeBasesRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
prepareAgent
default CompletableFuture<PrepareAgentResponse> prepareAgent(PrepareAgentRequest prepareAgentRequest)
Creates a
DRAFTversion 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 invokeThrowable.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:
- AWS API Documentation
-
prepareAgent
default CompletableFuture<PrepareAgentResponse> prepareAgent(Consumer<PrepareAgentRequest.Builder> prepareAgentRequest)
Creates a
DRAFTversion of the agent that can be used for internal testing.
This is a convenience which creates an instance of the
PrepareAgentRequest.Builderavoiding the need to create one manually viaPrepareAgentRequest.builder()- Parameters:
prepareAgentRequest- AConsumerthat will call methods onPrepareAgentRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaStartIngestionJobRequest.builder()- Parameters:
startIngestionJobRequest- AConsumerthat will call methods onStartIngestionJobRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateAgentRequest.builder()- Parameters:
updateAgentRequest- AConsumerthat will call methods onUpdateAgentRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateAgentActionGroupRequest.builder()- Parameters:
updateAgentActionGroupRequest- AConsumerthat will call methods onUpdateAgentActionGroupRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateAgentAliasRequest.builder()- Parameters:
updateAgentAliasRequest- AConsumerthat will call methods onUpdateAgentAliasRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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 invokeThrowable.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:
- AWS API Documentation
-
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.Builderavoiding the need to create one manually viaUpdateAgentKnowledgeBaseRequest.builder()- Parameters:
updateAgentKnowledgeBaseRequest- AConsumerthat will call methods onUpdateAgentKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates configurations for a data source.
You can't change the
chunkingConfigurationafter you create the data source. Specify the existingchunkingConfiguration.- 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 invokeThrowable.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:
- AWS API Documentation
-
updateDataSource
default CompletableFuture<UpdateDataSourceResponse> updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)
Updates configurations for a data source.
You can't change the
chunkingConfigurationafter you create the data source. Specify the existingchunkingConfiguration.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
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
knowledgeBaseConfigurationorstorageConfigurationfields, 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 invokeThrowable.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:
- AWS API Documentation
-
-
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
knowledgeBaseConfigurationorstorageConfigurationfields, 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.Builderavoiding the need to create one manually viaUpdateKnowledgeBaseRequest.builder()- Parameters:
updateKnowledgeBaseRequest- AConsumerthat will call methods onUpdateKnowledgeBaseRequest.Builderto 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 invokeThrowable.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:
- AWS API Documentation
-
-
serviceClientConfiguration
default BedrockAgentServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static BedrockAgentAsyncClient create()
Create aBedrockAgentAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static BedrockAgentAsyncClientBuilder builder()
Create a builder that can be used to configure and create aBedrockAgentAsyncClient.
-
-