Interface BedrockAgentClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BedrockAgentClient extends AwsClient
Service client for accessing Agents for Amazon Bedrock. This can be created using the staticbuilder()method.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
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AssociateAgentKnowledgeBaseResponseassociateAgentKnowledgeBase(Consumer<AssociateAgentKnowledgeBaseRequest.Builder> associateAgentKnowledgeBaseRequest)Associates a knowledge base with an agent.default AssociateAgentKnowledgeBaseResponseassociateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)Associates a knowledge base with an agent.static BedrockAgentClientBuilderbuilder()Create a builder that can be used to configure and create aBedrockAgentClient.static BedrockAgentClientcreate()Create aBedrockAgentClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateAgentResponsecreateAgent(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.default CreateAgentResponsecreateAgent(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.default CreateAgentActionGroupResponsecreateAgentActionGroup(Consumer<CreateAgentActionGroupRequest.Builder> createAgentActionGroupRequest)Creates an action group for an agent.default CreateAgentActionGroupResponsecreateAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest)Creates an action group for an agent.default CreateAgentAliasResponsecreateAgentAlias(Consumer<CreateAgentAliasRequest.Builder> createAgentAliasRequest)Creates an alias of an agent that can be used to deploy the agent.default CreateAgentAliasResponsecreateAgentAlias(CreateAgentAliasRequest createAgentAliasRequest)Creates an alias of an agent that can be used to deploy the agent.default CreateDataSourceResponsecreateDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest)Creates a data source connector for a knowledge base.default CreateDataSourceResponsecreateDataSource(CreateDataSourceRequest createDataSourceRequest)Creates a data source connector for a knowledge base.default CreateFlowResponsecreateFlow(Consumer<CreateFlowRequest.Builder> createFlowRequest)Creates a prompt flow that you can use to send an input through various steps to yield an output.default CreateFlowResponsecreateFlow(CreateFlowRequest createFlowRequest)Creates a prompt flow that you can use to send an input through various steps to yield an output.default CreateFlowAliasResponsecreateFlowAlias(Consumer<CreateFlowAliasRequest.Builder> createFlowAliasRequest)Creates an alias of a flow for deployment.default CreateFlowAliasResponsecreateFlowAlias(CreateFlowAliasRequest createFlowAliasRequest)Creates an alias of a flow for deployment.default CreateFlowVersionResponsecreateFlowVersion(Consumer<CreateFlowVersionRequest.Builder> createFlowVersionRequest)Creates a version of the flow that you can deploy.default CreateFlowVersionResponsecreateFlowVersion(CreateFlowVersionRequest createFlowVersionRequest)Creates a version of the flow that you can deploy.default CreateKnowledgeBaseResponsecreateKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest)Creates a knowledge base.default CreateKnowledgeBaseResponsecreateKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)Creates a knowledge base.default CreatePromptResponsecreatePrompt(Consumer<CreatePromptRequest.Builder> createPromptRequest)Creates a prompt in your prompt library that you can add to a flow.default CreatePromptResponsecreatePrompt(CreatePromptRequest createPromptRequest)Creates a prompt in your prompt library that you can add to a flow.default CreatePromptVersionResponsecreatePromptVersion(Consumer<CreatePromptVersionRequest.Builder> createPromptVersionRequest)Creates a static snapshot of your prompt that can be deployed to production.default CreatePromptVersionResponsecreatePromptVersion(CreatePromptVersionRequest createPromptVersionRequest)Creates a static snapshot of your prompt that can be deployed to production.default DeleteAgentResponsedeleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest)Deletes an agent.default DeleteAgentResponsedeleteAgent(DeleteAgentRequest deleteAgentRequest)Deletes an agent.default DeleteAgentActionGroupResponsedeleteAgentActionGroup(Consumer<DeleteAgentActionGroupRequest.Builder> deleteAgentActionGroupRequest)Deletes an action group in an agent.default DeleteAgentActionGroupResponsedeleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest)Deletes an action group in an agent.default DeleteAgentAliasResponsedeleteAgentAlias(Consumer<DeleteAgentAliasRequest.Builder> deleteAgentAliasRequest)Deletes an alias of an agent.default DeleteAgentAliasResponsedeleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest)Deletes an alias of an agent.default DeleteAgentVersionResponsedeleteAgentVersion(Consumer<DeleteAgentVersionRequest.Builder> deleteAgentVersionRequest)Deletes a version of an agent.default DeleteAgentVersionResponsedeleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest)Deletes a version of an agent.default DeleteDataSourceResponsedeleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest)Deletes a data source from a knowledge base.default DeleteDataSourceResponsedeleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)Deletes a data source from a knowledge base.default DeleteFlowResponsedeleteFlow(Consumer<DeleteFlowRequest.Builder> deleteFlowRequest)Deletes a flow.default DeleteFlowResponsedeleteFlow(DeleteFlowRequest deleteFlowRequest)Deletes a flow.default DeleteFlowAliasResponsedeleteFlowAlias(Consumer<DeleteFlowAliasRequest.Builder> deleteFlowAliasRequest)Deletes an alias of a flow.default DeleteFlowAliasResponsedeleteFlowAlias(DeleteFlowAliasRequest deleteFlowAliasRequest)Deletes an alias of a flow.default DeleteFlowVersionResponsedeleteFlowVersion(Consumer<DeleteFlowVersionRequest.Builder> deleteFlowVersionRequest)Deletes a version of a flow.default DeleteFlowVersionResponsedeleteFlowVersion(DeleteFlowVersionRequest deleteFlowVersionRequest)Deletes a version of a flow.default DeleteKnowledgeBaseResponsedeleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest)Deletes a knowledge base.default DeleteKnowledgeBaseResponsedeleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)Deletes a knowledge base.default DeletePromptResponsedeletePrompt(Consumer<DeletePromptRequest.Builder> deletePromptRequest)Deletes a prompt or a version of it, depending on whether you include thepromptVersionfield or not.default DeletePromptResponsedeletePrompt(DeletePromptRequest deletePromptRequest)Deletes a prompt or a version of it, depending on whether you include thepromptVersionfield or not.default DisassociateAgentKnowledgeBaseResponsedisassociateAgentKnowledgeBase(Consumer<DisassociateAgentKnowledgeBaseRequest.Builder> disassociateAgentKnowledgeBaseRequest)Disassociates a knowledge base from an agent.default DisassociateAgentKnowledgeBaseResponsedisassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest)Disassociates a knowledge base from an agent.default GetAgentResponsegetAgent(Consumer<GetAgentRequest.Builder> getAgentRequest)Gets information about an agent.default GetAgentResponsegetAgent(GetAgentRequest getAgentRequest)Gets information about an agent.default GetAgentActionGroupResponsegetAgentActionGroup(Consumer<GetAgentActionGroupRequest.Builder> getAgentActionGroupRequest)Gets information about an action group for an agent.default GetAgentActionGroupResponsegetAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest)Gets information about an action group for an agent.default GetAgentAliasResponsegetAgentAlias(Consumer<GetAgentAliasRequest.Builder> getAgentAliasRequest)Gets information about an alias of an agent.default GetAgentAliasResponsegetAgentAlias(GetAgentAliasRequest getAgentAliasRequest)Gets information about an alias of an agent.default GetAgentKnowledgeBaseResponsegetAgentKnowledgeBase(Consumer<GetAgentKnowledgeBaseRequest.Builder> getAgentKnowledgeBaseRequest)Gets information about a knowledge base associated with an agent.default GetAgentKnowledgeBaseResponsegetAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest)Gets information about a knowledge base associated with an agent.default GetAgentVersionResponsegetAgentVersion(Consumer<GetAgentVersionRequest.Builder> getAgentVersionRequest)Gets details about a version of an agent.default GetAgentVersionResponsegetAgentVersion(GetAgentVersionRequest getAgentVersionRequest)Gets details about a version of an agent.default GetDataSourceResponsegetDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest)Gets information about a data source.default GetDataSourceResponsegetDataSource(GetDataSourceRequest getDataSourceRequest)Gets information about a data source.default GetFlowResponsegetFlow(Consumer<GetFlowRequest.Builder> getFlowRequest)Retrieves information about a flow.default GetFlowResponsegetFlow(GetFlowRequest getFlowRequest)Retrieves information about a flow.default GetFlowAliasResponsegetFlowAlias(Consumer<GetFlowAliasRequest.Builder> getFlowAliasRequest)Retrieves information about a flow.default GetFlowAliasResponsegetFlowAlias(GetFlowAliasRequest getFlowAliasRequest)Retrieves information about a flow.default GetFlowVersionResponsegetFlowVersion(Consumer<GetFlowVersionRequest.Builder> getFlowVersionRequest)Retrieves information about a version of a flow.default GetFlowVersionResponsegetFlowVersion(GetFlowVersionRequest getFlowVersionRequest)Retrieves information about a version of a flow.default GetIngestionJobResponsegetIngestionJob(Consumer<GetIngestionJobRequest.Builder> getIngestionJobRequest)Gets information about a data ingestion job.default GetIngestionJobResponsegetIngestionJob(GetIngestionJobRequest getIngestionJobRequest)Gets information about a data ingestion job.default GetKnowledgeBaseResponsegetKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest)Gets information about a knoweldge base.default GetKnowledgeBaseResponsegetKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)Gets information about a knoweldge base.default GetPromptResponsegetPrompt(Consumer<GetPromptRequest.Builder> getPromptRequest)Retrieves information about the working draft (DRAFTversion) of a prompt or a version of it, depending on whether you include thepromptVersionfield or not.default GetPromptResponsegetPrompt(GetPromptRequest getPromptRequest)Retrieves information about the working draft (DRAFTversion) of a prompt or a version of it, depending on whether you include thepromptVersionfield or not.default ListAgentActionGroupsResponselistAgentActionGroups(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest)Lists the action groups for an agent and information about each one.default ListAgentActionGroupsResponselistAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest)Lists the action groups for an agent and information about each one.default ListAgentActionGroupsIterablelistAgentActionGroupsPaginator(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest)This is a variant oflistAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)operation.default ListAgentActionGroupsIterablelistAgentActionGroupsPaginator(ListAgentActionGroupsRequest listAgentActionGroupsRequest)This is a variant oflistAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)operation.default ListAgentAliasesResponselistAgentAliases(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest)Lists the aliases of an agent and information about each one.default ListAgentAliasesResponselistAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest)Lists the aliases of an agent and information about each one.default ListAgentAliasesIterablelistAgentAliasesPaginator(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest)This is a variant oflistAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)operation.default ListAgentAliasesIterablelistAgentAliasesPaginator(ListAgentAliasesRequest listAgentAliasesRequest)This is a variant oflistAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)operation.default ListAgentKnowledgeBasesResponselistAgentKnowledgeBases(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest)Lists knowledge bases associated with an agent and information about each one.default ListAgentKnowledgeBasesResponselistAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)Lists knowledge bases associated with an agent and information about each one.default ListAgentKnowledgeBasesIterablelistAgentKnowledgeBasesPaginator(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest)This is a variant oflistAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)operation.default ListAgentKnowledgeBasesIterablelistAgentKnowledgeBasesPaginator(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)This is a variant oflistAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)operation.default ListAgentsResponselistAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest)Lists the agents belonging to an account and information about each agent.default ListAgentsResponselistAgents(ListAgentsRequest listAgentsRequest)Lists the agents belonging to an account and information about each agent.default ListAgentsIterablelistAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest)This is a variant oflistAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)operation.default ListAgentsIterablelistAgentsPaginator(ListAgentsRequest listAgentsRequest)This is a variant oflistAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)operation.default ListAgentVersionsResponselistAgentVersions(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest)Lists the versions of an agent and information about each version.default ListAgentVersionsResponselistAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest)Lists the versions of an agent and information about each version.default ListAgentVersionsIterablelistAgentVersionsPaginator(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest)This is a variant oflistAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)operation.default ListAgentVersionsIterablelistAgentVersionsPaginator(ListAgentVersionsRequest listAgentVersionsRequest)This is a variant oflistAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)operation.default ListDataSourcesResponselistDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)Lists the data sources in a knowledge base and information about each one.default ListDataSourcesResponselistDataSources(ListDataSourcesRequest listDataSourcesRequest)Lists the data sources in a knowledge base and information about each one.default ListDataSourcesIterablelistDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest)This is a variant oflistDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)operation.default ListDataSourcesIterablelistDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest)This is a variant oflistDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)operation.default ListFlowAliasesResponselistFlowAliases(Consumer<ListFlowAliasesRequest.Builder> listFlowAliasesRequest)Returns a list of aliases for a flow.default ListFlowAliasesResponselistFlowAliases(ListFlowAliasesRequest listFlowAliasesRequest)Returns a list of aliases for a flow.default ListFlowAliasesIterablelistFlowAliasesPaginator(Consumer<ListFlowAliasesRequest.Builder> listFlowAliasesRequest)This is a variant oflistFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)operation.default ListFlowAliasesIterablelistFlowAliasesPaginator(ListFlowAliasesRequest listFlowAliasesRequest)This is a variant oflistFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)operation.default ListFlowsResponselistFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest)Returns a list of flows and information about each flow.default ListFlowsResponselistFlows(ListFlowsRequest listFlowsRequest)Returns a list of flows and information about each flow.default ListFlowsIterablelistFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest)This is a variant oflistFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)operation.default ListFlowsIterablelistFlowsPaginator(ListFlowsRequest listFlowsRequest)This is a variant oflistFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)operation.default ListFlowVersionsResponselistFlowVersions(Consumer<ListFlowVersionsRequest.Builder> listFlowVersionsRequest)Returns a list of information about each flow.default ListFlowVersionsResponselistFlowVersions(ListFlowVersionsRequest listFlowVersionsRequest)Returns a list of information about each flow.default ListFlowVersionsIterablelistFlowVersionsPaginator(Consumer<ListFlowVersionsRequest.Builder> listFlowVersionsRequest)This is a variant oflistFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)operation.default ListFlowVersionsIterablelistFlowVersionsPaginator(ListFlowVersionsRequest listFlowVersionsRequest)This is a variant oflistFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)operation.default ListIngestionJobsResponselistIngestionJobs(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest)Lists the data ingestion jobs for a data source.default ListIngestionJobsResponselistIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest)Lists the data ingestion jobs for a data source.default ListIngestionJobsIterablelistIngestionJobsPaginator(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest)This is a variant oflistIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)operation.default ListIngestionJobsIterablelistIngestionJobsPaginator(ListIngestionJobsRequest listIngestionJobsRequest)This is a variant oflistIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)operation.default ListKnowledgeBasesResponselistKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)Lists the knowledge bases in an account.default ListKnowledgeBasesResponselistKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)Lists the knowledge bases in an account.default ListKnowledgeBasesIterablelistKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest)This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)operation.default ListKnowledgeBasesIterablelistKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest)This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)operation.default ListPromptsResponselistPrompts(Consumer<ListPromptsRequest.Builder> listPromptsRequest)Returns either information about the working draft (DRAFTversion) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifierfield or not.default ListPromptsResponselistPrompts(ListPromptsRequest listPromptsRequest)Returns either information about the working draft (DRAFTversion) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifierfield or not.default ListPromptsIterablelistPromptsPaginator(Consumer<ListPromptsRequest.Builder> listPromptsRequest)This is a variant oflistPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)operation.default ListPromptsIterablelistPromptsPaginator(ListPromptsRequest listPromptsRequest)This is a variant oflistPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)List all the tags for the resource you specify.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)List all the tags for the resource you specify.default PrepareAgentResponseprepareAgent(Consumer<PrepareAgentRequest.Builder> prepareAgentRequest)Creates aDRAFTversion of the agent that can be used for internal testing.default PrepareAgentResponseprepareAgent(PrepareAgentRequest prepareAgentRequest)Creates aDRAFTversion of the agent that can be used for internal testing.default PrepareFlowResponseprepareFlow(Consumer<PrepareFlowRequest.Builder> prepareFlowRequest)Prepares theDRAFTversion of a flow so that it can be invoked.default PrepareFlowResponseprepareFlow(PrepareFlowRequest prepareFlowRequest)Prepares theDRAFTversion of a flow so that it can be invoked.default BedrockAgentServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartIngestionJobResponsestartIngestionJob(Consumer<StartIngestionJobRequest.Builder> startIngestionJobRequest)Begins a data ingestion job.default StartIngestionJobResponsestartIngestionJob(StartIngestionJobRequest startIngestionJobRequest)Begins a data ingestion job.default StopIngestionJobResponsestopIngestionJob(Consumer<StopIngestionJobRequest.Builder> stopIngestionJobRequest)Stops a currently running data ingestion job.default StopIngestionJobResponsestopIngestionJob(StopIngestionJobRequest stopIngestionJobRequest)Stops a currently running data ingestion job.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)Associate tags with a resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest)Associate tags with a resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)Remove tags from a resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest)Remove tags from a resource.default UpdateAgentResponseupdateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest)Updates the configuration of an agent.default UpdateAgentResponseupdateAgent(UpdateAgentRequest updateAgentRequest)Updates the configuration of an agent.default UpdateAgentActionGroupResponseupdateAgentActionGroup(Consumer<UpdateAgentActionGroupRequest.Builder> updateAgentActionGroupRequest)Updates the configuration for an action group for an agent.default UpdateAgentActionGroupResponseupdateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest)Updates the configuration for an action group for an agent.default UpdateAgentAliasResponseupdateAgentAlias(Consumer<UpdateAgentAliasRequest.Builder> updateAgentAliasRequest)Updates configurations for an alias of an agent.default UpdateAgentAliasResponseupdateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest)Updates configurations for an alias of an agent.default UpdateAgentKnowledgeBaseResponseupdateAgentKnowledgeBase(Consumer<UpdateAgentKnowledgeBaseRequest.Builder> updateAgentKnowledgeBaseRequest)Updates the configuration for a knowledge base that has been associated with an agent.default UpdateAgentKnowledgeBaseResponseupdateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest)Updates the configuration for a knowledge base that has been associated with an agent.default UpdateDataSourceResponseupdateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest)Updates the configurations for a data source connector.default UpdateDataSourceResponseupdateDataSource(UpdateDataSourceRequest updateDataSourceRequest)Updates the configurations for a data source connector.default UpdateFlowResponseupdateFlow(Consumer<UpdateFlowRequest.Builder> updateFlowRequest)Modifies a flow.default UpdateFlowResponseupdateFlow(UpdateFlowRequest updateFlowRequest)Modifies a flow.default UpdateFlowAliasResponseupdateFlowAlias(Consumer<UpdateFlowAliasRequest.Builder> updateFlowAliasRequest)Modifies the alias of a flow.default UpdateFlowAliasResponseupdateFlowAlias(UpdateFlowAliasRequest updateFlowAliasRequest)Modifies the alias of a flow.default UpdateKnowledgeBaseResponseupdateKnowledgeBase(Consumer<UpdateKnowledgeBaseRequest.Builder> updateKnowledgeBaseRequest)Updates the configuration of a knowledge base with the fields that you specify.default UpdateKnowledgeBaseResponseupdateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest)Updates the configuration of a knowledge base with the fields that you specify.default UpdatePromptResponseupdatePrompt(Consumer<UpdatePromptRequest.Builder> updatePromptRequest)Modifies a prompt in your prompt library.default UpdatePromptResponseupdatePrompt(UpdatePromptRequest updatePromptRequest)Modifies a prompt in your prompt library.-
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 AssociateAgentKnowledgeBaseResponse associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the AssociateAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
associateAgentKnowledgeBase
default AssociateAgentKnowledgeBaseResponse associateAgentKnowledgeBase(Consumer<AssociateAgentKnowledgeBaseRequest.Builder> associateAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the AssociateAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createAgent
default CreateAgentResponse createAgent(CreateAgentRequest createAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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 enable your agent to retain conversational context across multiple sessions, include a
memoryConfigurationobject. For more information, see Configure memory. -
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfigurationobject. For more information, see Advanced prompts. -
If your agent fails to be created, the response returns a list of
failureReasonsalongside a list ofrecommendedActionsfor you to troubleshoot. -
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
- Parameters:
createAgentRequest-- Returns:
- Result of the CreateAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createAgent
default CreateAgentResponse createAgent(Consumer<CreateAgentRequest.Builder> createAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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 enable your agent to retain conversational context across multiple sessions, include a
memoryConfigurationobject. For more information, see Configure memory. -
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfigurationobject. For more information, see Advanced prompts. -
If your agent fails to be created, the response returns a list of
failureReasonsalongside a list ofrecommendedActionsfor you to troubleshoot. -
The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.
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:
- Result of the CreateAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createAgentActionGroup
default CreateAgentActionGroupResponse createAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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.To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the
parentActionGroupSignaturefield set toAMAZON.CodeInterpreter.You must leave the
description,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:
- Result of the CreateAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createAgentActionGroup
default CreateAgentActionGroupResponse createAgentActionGroup(Consumer<CreateAgentActionGroupRequest.Builder> createAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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.To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the
parentActionGroupSignaturefield set toAMAZON.CodeInterpreter.You must leave the
description,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:
- Result of the CreateAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createAgentAlias
default CreateAgentAliasResponse createAgentAlias(CreateAgentAliasRequest createAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates an alias of an agent that can be used to deploy the agent.
- Parameters:
createAgentAliasRequest-- Returns:
- Result of the CreateAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createAgentAlias
default CreateAgentAliasResponse createAgentAlias(Consumer<CreateAgentAliasRequest.Builder> createAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the CreateAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a data source connector for a knowledge base.
You can't change the
chunkingConfigurationafter you create the data source connector.- Parameters:
createDataSourceRequest-- Returns:
- Result of the CreateDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createDataSource
default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a data source connector for a knowledge base.
You can't change the
chunkingConfigurationafter you create the data source connector.
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:
- Result of the CreateDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlow
default CreateFlowResponse createFlow(CreateFlowRequest createFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
createFlowRequest-- Returns:
- Result of the CreateFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlow
default CreateFlowResponse createFlow(Consumer<CreateFlowRequest.Builder> createFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateFlowRequest.Builderavoiding the need to create one manually viaCreateFlowRequest.builder()- Parameters:
createFlowRequest- AConsumerthat will call methods onCreateFlowRequest.Builderto create a request.- Returns:
- Result of the CreateFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlowAlias
default CreateFlowAliasResponse createFlowAlias(CreateFlowAliasRequest createFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
createFlowAliasRequest-- Returns:
- Result of the CreateFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlowAlias
default CreateFlowAliasResponse createFlowAlias(Consumer<CreateFlowAliasRequest.Builder> createFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateFlowAliasRequest.Builderavoiding the need to create one manually viaCreateFlowAliasRequest.builder()- Parameters:
createFlowAliasRequest- AConsumerthat will call methods onCreateFlowAliasRequest.Builderto create a request.- Returns:
- Result of the CreateFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlowVersion
default CreateFlowVersionResponse createFlowVersion(CreateFlowVersionRequest createFlowVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
createFlowVersionRequest-- Returns:
- Result of the CreateFlowVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createFlowVersion
default CreateFlowVersionResponse createFlowVersion(Consumer<CreateFlowVersionRequest.Builder> createFlowVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreateFlowVersionRequest.Builderavoiding the need to create one manually viaCreateFlowVersionRequest.builder()- Parameters:
createFlowVersionRequest- AConsumerthat will call methods onCreateFlowVersionRequest.Builderto create a request.- Returns:
- Result of the CreateFlowVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base.
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:
- Result of the CreateKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base.
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:
- Result of the CreateKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
createPrompt
default CreatePromptResponse createPrompt(CreatePromptRequest createPromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
createPromptRequest-- Returns:
- Result of the CreatePrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPrompt
default CreatePromptResponse createPrompt(Consumer<CreatePromptRequest.Builder> createPromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreatePromptRequest.Builderavoiding the need to create one manually viaCreatePromptRequest.builder()- Parameters:
createPromptRequest- AConsumerthat will call methods onCreatePromptRequest.Builderto create a request.- Returns:
- Result of the CreatePrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPromptVersion
default CreatePromptVersionResponse createPromptVersion(CreatePromptVersionRequest createPromptVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
- Parameters:
createPromptVersionRequest-- Returns:
- Result of the CreatePromptVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
createPromptVersion
default CreatePromptVersionResponse createPromptVersion(Consumer<CreatePromptVersionRequest.Builder> createPromptVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
CreatePromptVersionRequest.Builderavoiding the need to create one manually viaCreatePromptVersionRequest.builder()- Parameters:
createPromptVersionRequest- AConsumerthat will call methods onCreatePromptVersionRequest.Builderto create a request.- Returns:
- Result of the CreatePromptVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgent
default DeleteAgentResponse deleteAgent(DeleteAgentRequest deleteAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes an agent.
- Parameters:
deleteAgentRequest-- Returns:
- Result of the DeleteAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgent
default DeleteAgentResponse deleteAgent(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgentActionGroup
default DeleteAgentActionGroupResponse deleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes an action group in an agent.
- Parameters:
deleteAgentActionGroupRequest-- Returns:
- Result of the DeleteAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgentActionGroup
default DeleteAgentActionGroupResponse deleteAgentActionGroup(Consumer<DeleteAgentActionGroupRequest.Builder> deleteAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgentAlias
default DeleteAgentAliasResponse deleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes an alias of an agent.
- Parameters:
deleteAgentAliasRequest-- Returns:
- Result of the DeleteAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgentAlias
default DeleteAgentAliasResponse deleteAgentAlias(Consumer<DeleteAgentAliasRequest.Builder> deleteAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgentVersion
default DeleteAgentVersionResponse deleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a version of an agent.
- Parameters:
deleteAgentVersionRequest-- Returns:
- Result of the DeleteAgentVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAgentVersion
default DeleteAgentVersionResponse deleteAgentVersion(Consumer<DeleteAgentVersionRequest.Builder> deleteAgentVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteAgentVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a data source from a knowledge base.
- Parameters:
deleteDataSourceRequest-- Returns:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlow
default DeleteFlowResponse deleteFlow(DeleteFlowRequest deleteFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a flow.
- Parameters:
deleteFlowRequest-- Returns:
- Result of the DeleteFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlow
default DeleteFlowResponse deleteFlow(Consumer<DeleteFlowRequest.Builder> deleteFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a flow.
This is a convenience which creates an instance of the
DeleteFlowRequest.Builderavoiding the need to create one manually viaDeleteFlowRequest.builder()- Parameters:
deleteFlowRequest- AConsumerthat will call methods onDeleteFlowRequest.Builderto create a request.- Returns:
- Result of the DeleteFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlowAlias
default DeleteFlowAliasResponse deleteFlowAlias(DeleteFlowAliasRequest deleteFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes an alias of a flow.
- Parameters:
deleteFlowAliasRequest-- Returns:
- Result of the DeleteFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlowAlias
default DeleteFlowAliasResponse deleteFlowAlias(Consumer<DeleteFlowAliasRequest.Builder> deleteFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes an alias of a flow.
This is a convenience which creates an instance of the
DeleteFlowAliasRequest.Builderavoiding the need to create one manually viaDeleteFlowAliasRequest.builder()- Parameters:
deleteFlowAliasRequest- AConsumerthat will call methods onDeleteFlowAliasRequest.Builderto create a request.- Returns:
- Result of the DeleteFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlowVersion
default DeleteFlowVersionResponse deleteFlowVersion(DeleteFlowVersionRequest deleteFlowVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a version of a flow.
- Parameters:
deleteFlowVersionRequest-- Returns:
- Result of the DeleteFlowVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteFlowVersion
default DeleteFlowVersionResponse deleteFlowVersion(Consumer<DeleteFlowVersionRequest.Builder> deleteFlowVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a version of a flow.
This is a convenience which creates an instance of the
DeleteFlowVersionRequest.Builderavoiding the need to create one manually viaDeleteFlowVersionRequest.builder()- Parameters:
deleteFlowVersionRequest- AConsumerthat will call methods onDeleteFlowVersionRequest.Builderto create a request.- Returns:
- Result of the DeleteFlowVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteKnowledgeBase
default DeleteKnowledgeBaseResponse deleteKnowledgeBase(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DeleteKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePrompt
default DeletePromptResponse deletePrompt(DeletePromptRequest deletePromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a prompt or a version of it, depending on whether you include the
promptVersionfield or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.- Parameters:
deletePromptRequest-- Returns:
- Result of the DeletePrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deletePrompt
default DeletePromptResponse deletePrompt(Consumer<DeletePromptRequest.Builder> deletePromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Deletes a prompt or a version of it, depending on whether you include the
promptVersionfield or not. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
DeletePromptRequest.Builderavoiding the need to create one manually viaDeletePromptRequest.builder()- Parameters:
deletePromptRequest- AConsumerthat will call methods onDeletePromptRequest.Builderto create a request.- Returns:
- Result of the DeletePrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateAgentKnowledgeBase
default DisassociateAgentKnowledgeBaseResponse disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Disassociates a knowledge base from an agent.
- Parameters:
disassociateAgentKnowledgeBaseRequest-- Returns:
- Result of the DisassociateAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
disassociateAgentKnowledgeBase
default DisassociateAgentKnowledgeBaseResponse disassociateAgentKnowledgeBase(Consumer<DisassociateAgentKnowledgeBaseRequest.Builder> disassociateAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the DisassociateAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgent
default GetAgentResponse getAgent(GetAgentRequest getAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about an agent.
- Parameters:
getAgentRequest-- Returns:
- Result of the GetAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgent
default GetAgentResponse getAgent(Consumer<GetAgentRequest.Builder> getAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentActionGroup
default GetAgentActionGroupResponse getAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about an action group for an agent.
- Parameters:
getAgentActionGroupRequest-- Returns:
- Result of the GetAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentActionGroup
default GetAgentActionGroupResponse getAgentActionGroup(Consumer<GetAgentActionGroupRequest.Builder> getAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentAlias
default GetAgentAliasResponse getAgentAlias(GetAgentAliasRequest getAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about an alias of an agent.
- Parameters:
getAgentAliasRequest-- Returns:
- Result of the GetAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentAlias
default GetAgentAliasResponse getAgentAlias(Consumer<GetAgentAliasRequest.Builder> getAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentKnowledgeBase
default GetAgentKnowledgeBaseResponse getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about a knowledge base associated with an agent.
- Parameters:
getAgentKnowledgeBaseRequest-- Returns:
- Result of the GetAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentKnowledgeBase
default GetAgentKnowledgeBaseResponse getAgentKnowledgeBase(Consumer<GetAgentKnowledgeBaseRequest.Builder> getAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentVersion
default GetAgentVersionResponse getAgentVersion(GetAgentVersionRequest getAgentVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets details about a version of an agent.
- Parameters:
getAgentVersionRequest-- Returns:
- Result of the GetAgentVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getAgentVersion
default GetAgentVersionResponse getAgentVersion(Consumer<GetAgentVersionRequest.Builder> getAgentVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetAgentVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDataSource
default GetDataSourceResponse getDataSource(GetDataSourceRequest getDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about a data source.
- Parameters:
getDataSourceRequest-- Returns:
- Result of the GetDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getDataSource
default GetDataSourceResponse getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getFlow
default GetFlowResponse getFlow(GetFlowRequest getFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
getFlowRequest-- Returns:
- Result of the GetFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getFlow
default GetFlowResponse getFlow(Consumer<GetFlowRequest.Builder> getFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetFlowRequest.Builderavoiding the need to create one manually viaGetFlowRequest.builder()- Parameters:
getFlowRequest- AConsumerthat will call methods onGetFlowRequest.Builderto create a request.- Returns:
- Result of the GetFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getFlowAlias
default GetFlowAliasResponse getFlowAlias(GetFlowAliasRequest getFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
getFlowAliasRequest-- Returns:
- Result of the GetFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getFlowAlias
default GetFlowAliasResponse getFlowAlias(Consumer<GetFlowAliasRequest.Builder> getFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetFlowAliasRequest.Builderavoiding the need to create one manually viaGetFlowAliasRequest.builder()- Parameters:
getFlowAliasRequest- AConsumerthat will call methods onGetFlowAliasRequest.Builderto create a request.- Returns:
- Result of the GetFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getFlowVersion
default GetFlowVersionResponse getFlowVersion(GetFlowVersionRequest getFlowVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
getFlowVersionRequest-- Returns:
- Result of the GetFlowVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getFlowVersion
default GetFlowVersionResponse getFlowVersion(Consumer<GetFlowVersionRequest.Builder> getFlowVersionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetFlowVersionRequest.Builderavoiding the need to create one manually viaGetFlowVersionRequest.builder()- Parameters:
getFlowVersionRequest- AConsumerthat will call methods onGetFlowVersionRequest.Builderto create a request.- Returns:
- Result of the GetFlowVersion operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getIngestionJob
default GetIngestionJobResponse getIngestionJob(GetIngestionJobRequest getIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
- Parameters:
getIngestionJobRequest-- Returns:
- Result of the GetIngestionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getIngestionJob
default GetIngestionJobResponse getIngestionJob(Consumer<GetIngestionJobRequest.Builder> getIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
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:
- Result of the GetIngestionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Gets information about a knoweldge base.
- Parameters:
getKnowledgeBaseRequest-- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getKnowledgeBase
default GetKnowledgeBaseResponse getKnowledgeBase(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the GetKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getPrompt
default GetPromptResponse getPrompt(GetPromptRequest getPromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about the working draft (
DRAFTversion) of a prompt or a version of it, depending on whether you include thepromptVersionfield or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.- Parameters:
getPromptRequest-- Returns:
- Result of the GetPrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getPrompt
default GetPromptResponse getPrompt(Consumer<GetPromptRequest.Builder> getPromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Retrieves information about the working draft (
DRAFTversion) of a prompt or a version of it, depending on whether you include thepromptVersionfield or not. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetPromptRequest.Builderavoiding the need to create one manually viaGetPromptRequest.builder()- Parameters:
getPromptRequest- AConsumerthat will call methods onGetPromptRequest.Builderto create a request.- Returns:
- Result of the GetPrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentActionGroups
default ListAgentActionGroupsResponse listAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the action groups for an agent and information about each one.
- Parameters:
listAgentActionGroupsRequest-- Returns:
- Result of the ListAgentActionGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentActionGroups
default ListAgentActionGroupsResponse listAgentActionGroups(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListAgentActionGroups operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentActionGroupsPaginator
default ListAgentActionGroupsIterable listAgentActionGroupsPaginator(ListAgentActionGroupsRequest listAgentActionGroupsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsIterable responses = client.listAgentActionGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsIterable responses = client .listAgentActionGroupsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsIterable responses = client.listAgentActionGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)operation.- Parameters:
listAgentActionGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentActionGroupsPaginator
default ListAgentActionGroupsIterable listAgentActionGroupsPaginator(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsIterable responses = client.listAgentActionGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsIterable responses = client .listAgentActionGroupsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentActionGroupsIterable responses = client.listAgentActionGroupsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentAliases
default ListAgentAliasesResponse listAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the aliases of an agent and information about each one.
- Parameters:
listAgentAliasesRequest-- Returns:
- Result of the ListAgentAliases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentAliases
default ListAgentAliasesResponse listAgentAliases(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListAgentAliases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentAliasesPaginator
default ListAgentAliasesIterable listAgentAliasesPaginator(ListAgentAliasesRequest listAgentAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesIterable responses = client.listAgentAliasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesIterable responses = client .listAgentAliasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesIterable responses = client.listAgentAliasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)operation.- Parameters:
listAgentAliasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentAliasesPaginator
default ListAgentAliasesIterable listAgentAliasesPaginator(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesIterable responses = client.listAgentAliasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesIterable responses = client .listAgentAliasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentAliasesIterable responses = client.listAgentAliasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentKnowledgeBases
default ListAgentKnowledgeBasesResponse listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists knowledge bases associated with an agent and information about each one.
- Parameters:
listAgentKnowledgeBasesRequest-- Returns:
- Result of the ListAgentKnowledgeBases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentKnowledgeBases
default ListAgentKnowledgeBasesResponse listAgentKnowledgeBases(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListAgentKnowledgeBases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentKnowledgeBasesPaginator
default ListAgentKnowledgeBasesIterable listAgentKnowledgeBasesPaginator(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesIterable responses = client.listAgentKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesIterable responses = client .listAgentKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesIterable responses = client.listAgentKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)operation.- Parameters:
listAgentKnowledgeBasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentKnowledgeBasesPaginator
default ListAgentKnowledgeBasesIterable listAgentKnowledgeBasesPaginator(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesIterable responses = client.listAgentKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesIterable responses = client .listAgentKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentKnowledgeBasesIterable responses = client.listAgentKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentVersions
default ListAgentVersionsResponse listAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the versions of an agent and information about each version.
- Parameters:
listAgentVersionsRequest-- Returns:
- Result of the ListAgentVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentVersions
default ListAgentVersionsResponse listAgentVersions(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListAgentVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentVersionsPaginator
default ListAgentVersionsIterable listAgentVersionsPaginator(ListAgentVersionsRequest listAgentVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsIterable responses = client.listAgentVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsIterable responses = client .listAgentVersionsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsIterable responses = client.listAgentVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)operation.- Parameters:
listAgentVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentVersionsPaginator
default ListAgentVersionsIterable listAgentVersionsPaginator(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsIterable responses = client.listAgentVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsIterable responses = client .listAgentVersionsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentVersionsIterable responses = client.listAgentVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgents
default ListAgentsResponse listAgents(ListAgentsRequest listAgentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the agents belonging to an account and information about each agent.
- Parameters:
listAgentsRequest-- Returns:
- Result of the ListAgents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgents
default ListAgentsResponse listAgents(Consumer<ListAgentsRequest.Builder> listAgentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListAgents operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentsPaginator
default ListAgentsIterable listAgentsPaginator(ListAgentsRequest listAgentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)operation.- Parameters:
listAgentsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listAgentsPaginator
default ListAgentsIterable listAgentsPaginator(Consumer<ListAgentsRequest.Builder> listAgentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentsIterable responses = client.listAgentsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the data sources in a knowledge base and information about each one.
- Parameters:
listDataSourcesRequest-- Returns:
- Result of the ListDataSources operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSources
default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListDataSources operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(ListDataSourcesRequest listDataSourcesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)operation.- Parameters:
listDataSourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listDataSourcesPaginator
default ListDataSourcesIterable listDataSourcesPaginator(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesIterable responses = client .listDataSourcesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListDataSourcesIterable responses = client.listDataSourcesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowAliases
default ListFlowAliasesResponse listFlowAliases(ListFlowAliasesRequest listFlowAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Returns a list of aliases for a flow.
- Parameters:
listFlowAliasesRequest-- Returns:
- Result of the ListFlowAliases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowAliases
default ListFlowAliasesResponse listFlowAliases(Consumer<ListFlowAliasesRequest.Builder> listFlowAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Returns a list of aliases for a flow.
This is a convenience which creates an instance of the
ListFlowAliasesRequest.Builderavoiding the need to create one manually viaListFlowAliasesRequest.builder()- Parameters:
listFlowAliasesRequest- AConsumerthat will call methods onListFlowAliasesRequest.Builderto create a request.- Returns:
- Result of the ListFlowAliases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowAliasesPaginator
default ListFlowAliasesIterable listFlowAliasesPaginator(ListFlowAliasesRequest listFlowAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowAliasesIterable responses = client.listFlowAliasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListFlowAliasesIterable responses = client .listFlowAliasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowAliasesIterable responses = client.listFlowAliasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)operation.- Parameters:
listFlowAliasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowAliasesPaginator
default ListFlowAliasesIterable listFlowAliasesPaginator(Consumer<ListFlowAliasesRequest.Builder> listFlowAliasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowAliasesIterable responses = client.listFlowAliasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListFlowAliasesIterable responses = client .listFlowAliasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowAliasesIterable responses = client.listFlowAliasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)operation.
This is a convenience which creates an instance of the
ListFlowAliasesRequest.Builderavoiding the need to create one manually viaListFlowAliasesRequest.builder()- Parameters:
listFlowAliasesRequest- AConsumerthat will call methods onListFlowAliasesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowVersions
default ListFlowVersionsResponse listFlowVersions(ListFlowVersionsRequest listFlowVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
listFlowVersionsRequest-- Returns:
- Result of the ListFlowVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowVersions
default ListFlowVersionsResponse listFlowVersions(Consumer<ListFlowVersionsRequest.Builder> listFlowVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListFlowVersionsRequest.Builderavoiding the need to create one manually viaListFlowVersionsRequest.builder()- Parameters:
listFlowVersionsRequest- AConsumerthat will call methods onListFlowVersionsRequest.Builderto create a request.- Returns:
- Result of the ListFlowVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowVersionsPaginator
default ListFlowVersionsIterable listFlowVersionsPaginator(ListFlowVersionsRequest listFlowVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowVersionsIterable responses = client.listFlowVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListFlowVersionsIterable responses = client .listFlowVersionsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowVersionsIterable responses = client.listFlowVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)operation.- Parameters:
listFlowVersionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowVersionsPaginator
default ListFlowVersionsIterable listFlowVersionsPaginator(Consumer<ListFlowVersionsRequest.Builder> listFlowVersionsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowVersionsIterable responses = client.listFlowVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListFlowVersionsIterable responses = client .listFlowVersionsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowVersionsIterable responses = client.listFlowVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)operation.
This is a convenience which creates an instance of the
ListFlowVersionsRequest.Builderavoiding the need to create one manually viaListFlowVersionsRequest.builder()- Parameters:
listFlowVersionsRequest- AConsumerthat will call methods onListFlowVersionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlows
default ListFlowsResponse listFlows(ListFlowsRequest listFlowsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
listFlowsRequest-- Returns:
- Result of the ListFlows operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlows
default ListFlowsResponse listFlows(Consumer<ListFlowsRequest.Builder> listFlowsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListFlowsRequest.Builderavoiding the need to create one manually viaListFlowsRequest.builder()- Parameters:
listFlowsRequest- AConsumerthat will call methods onListFlowsRequest.Builderto create a request.- Returns:
- Result of the ListFlows operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowsPaginator
default ListFlowsIterable listFlowsPaginator(ListFlowsRequest listFlowsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListFlowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)operation.- Parameters:
listFlowsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listFlowsPaginator
default ListFlowsIterable listFlowsPaginator(Consumer<ListFlowsRequest.Builder> listFlowsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListFlowsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListFlowsIterable responses = client.listFlowsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)operation.
This is a convenience which creates an instance of the
ListFlowsRequest.Builderavoiding the need to create one manually viaListFlowsRequest.builder()- Parameters:
listFlowsRequest- AConsumerthat will call methods onListFlowsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestionJobs
default ListIngestionJobsResponse listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the data ingestion jobs for a data source. The list also includes information about each job.
- Parameters:
listIngestionJobsRequest-- Returns:
- Result of the ListIngestionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestionJobs
default ListIngestionJobsResponse listIngestionJobs(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the data ingestion jobs for a data source. The list also includes information about each job.
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:
- Result of the ListIngestionJobs operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestionJobsPaginator
default ListIngestionJobsIterable listIngestionJobsPaginator(ListIngestionJobsRequest listIngestionJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsIterable responses = client.listIngestionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsIterable responses = client .listIngestionJobsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsIterable responses = client.listIngestionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)operation.- Parameters:
listIngestionJobsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listIngestionJobsPaginator
default ListIngestionJobsIterable listIngestionJobsPaginator(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsIterable responses = client.listIngestionJobsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsIterable responses = client .listIngestionJobsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListIngestionJobsIterable responses = client.listIngestionJobsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
- Parameters:
listKnowledgeBasesRequest-- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.
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:
- Result of the ListKnowledgeBases operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)operation.- Parameters:
listKnowledgeBasesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listKnowledgeBasesPaginator
default ListKnowledgeBasesIterable listKnowledgeBasesPaginator(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesIterable responses = client .listKnowledgeBasesPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBasesIterable responses = client.listKnowledgeBasesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrompts
default ListPromptsResponse listPrompts(ListPromptsRequest listPromptsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Returns either information about the working draft (
DRAFTversion) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifierfield or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.- Parameters:
listPromptsRequest-- Returns:
- Result of the ListPrompts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPrompts
default ListPromptsResponse listPrompts(Consumer<ListPromptsRequest.Builder> listPromptsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Returns either information about the working draft (
DRAFTversion) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifierfield or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListPromptsRequest.Builderavoiding the need to create one manually viaListPromptsRequest.builder()- Parameters:
listPromptsRequest- AConsumerthat will call methods onListPromptsRequest.Builderto create a request.- Returns:
- Result of the ListPrompts operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPromptsPaginator
default ListPromptsIterable listPromptsPaginator(ListPromptsRequest listPromptsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListPromptsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)operation.- Parameters:
listPromptsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listPromptsPaginator
default ListPromptsIterable listPromptsPaginator(Consumer<ListPromptsRequest.Builder> listPromptsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
This is a variant of
listPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.bedrockagent.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListPromptsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListPromptsIterable responses = client.listPromptsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)operation.
This is a convenience which creates an instance of the
ListPromptsRequest.Builderavoiding the need to create one manually viaListPromptsRequest.builder()- Parameters:
listPromptsRequest- AConsumerthat will call methods onListPromptsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
List all the tags for the resource you specify.
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the ListTagsForResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
prepareAgent
default PrepareAgentResponse prepareAgent(PrepareAgentRequest prepareAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Creates a
DRAFTversion of the agent that can be used for internal testing.- Parameters:
prepareAgentRequest-- Returns:
- Result of the PrepareAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
prepareAgent
default PrepareAgentResponse prepareAgent(Consumer<PrepareAgentRequest.Builder> prepareAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the PrepareAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
prepareFlow
default PrepareFlowResponse prepareFlow(PrepareFlowRequest prepareFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Prepares the
DRAFTversion of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.- Parameters:
prepareFlowRequest-- Returns:
- Result of the PrepareFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
prepareFlow
default PrepareFlowResponse prepareFlow(Consumer<PrepareFlowRequest.Builder> prepareFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Prepares the
DRAFTversion of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
PrepareFlowRequest.Builderavoiding the need to create one manually viaPrepareFlowRequest.builder()- Parameters:
prepareFlowRequest- AConsumerthat will call methods onPrepareFlowRequest.Builderto create a request.- Returns:
- Result of the PrepareFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startIngestionJob
default StartIngestionJobResponse startIngestionJob(StartIngestionJobRequest startIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
- Parameters:
startIngestionJobRequest-- Returns:
- Result of the StartIngestionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startIngestionJob
default StartIngestionJobResponse startIngestionJob(Consumer<StartIngestionJobRequest.Builder> startIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.
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:
- Result of the StartIngestionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopIngestionJob
default StopIngestionJobResponse stopIngestionJob(StopIngestionJobRequest stopIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Stops a currently running data ingestion job. You can send a
StartIngestionJobrequest again to ingest the rest of your data when you are ready.- Parameters:
stopIngestionJobRequest-- Returns:
- Result of the StopIngestionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
stopIngestionJob
default StopIngestionJobResponse stopIngestionJob(Consumer<StopIngestionJobRequest.Builder> stopIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Stops a currently running data ingestion job. You can send a
StartIngestionJobrequest again to ingest the rest of your data when you are ready.
This is a convenience which creates an instance of the
StopIngestionJobRequest.Builderavoiding the need to create one manually viaStopIngestionJobRequest.builder()- Parameters:
stopIngestionJobRequest- AConsumerthat will call methods onStopIngestionJobRequest.Builderto create a request.- Returns:
- Result of the StopIngestionJob operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the TagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
Remove tags from a resource.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UntagResource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgent
default UpdateAgentResponse updateAgent(UpdateAgentRequest updateAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Updates the configuration of an agent.
- Parameters:
updateAgentRequest-- Returns:
- Result of the UpdateAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgent
default UpdateAgentResponse updateAgent(Consumer<UpdateAgentRequest.Builder> updateAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UpdateAgent operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgentActionGroup
default UpdateAgentActionGroupResponse updateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Updates the configuration for an action group for an agent.
- Parameters:
updateAgentActionGroupRequest-- Returns:
- Result of the UpdateAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgentActionGroup
default UpdateAgentActionGroupResponse updateAgentActionGroup(Consumer<UpdateAgentActionGroupRequest.Builder> updateAgentActionGroupRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UpdateAgentActionGroup operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgentAlias
default UpdateAgentAliasResponse updateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Updates configurations for an alias of an agent.
- Parameters:
updateAgentAliasRequest-- Returns:
- Result of the UpdateAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgentAlias
default UpdateAgentAliasResponse updateAgentAlias(Consumer<UpdateAgentAliasRequest.Builder> updateAgentAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UpdateAgentAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgentKnowledgeBase
default UpdateAgentKnowledgeBaseResponse updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Updates the configuration for a knowledge base that has been associated with an agent.
- Parameters:
updateAgentKnowledgeBaseRequest-- Returns:
- Result of the UpdateAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateAgentKnowledgeBase
default UpdateAgentKnowledgeBaseResponse updateAgentKnowledgeBase(Consumer<UpdateAgentKnowledgeBaseRequest.Builder> updateAgentKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UpdateAgentKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Updates the configurations for a data source connector.
You can't change the
chunkingConfigurationafter you create the data source connector. Specify the existingchunkingConfiguration.- Parameters:
updateDataSourceRequest-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
Updates the configurations for a data source connector.
You can't change the
chunkingConfigurationafter you create the data source connector. 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:
- Result of the UpdateDataSource operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFlow
default UpdateFlowResponse updateFlow(UpdateFlowRequest updateFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
updateFlowRequest-- Returns:
- Result of the UpdateFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFlow
default UpdateFlowResponse updateFlow(Consumer<UpdateFlowRequest.Builder> updateFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UpdateFlowRequest.Builderavoiding the need to create one manually viaUpdateFlowRequest.builder()- Parameters:
updateFlowRequest- AConsumerthat will call methods onUpdateFlowRequest.Builderto create a request.- Returns:
- Result of the UpdateFlow operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFlowAlias
default UpdateFlowAliasResponse updateFlowAlias(UpdateFlowAliasRequest updateFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
- Parameters:
updateFlowAliasRequest-- Returns:
- Result of the UpdateFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateFlowAlias
default UpdateFlowAliasResponse updateFlowAlias(Consumer<UpdateFlowAliasRequest.Builder> updateFlowAliasRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UpdateFlowAliasRequest.Builderavoiding the need to create one manually viaUpdateFlowAliasRequest.builder()- Parameters:
updateFlowAliasRequest- AConsumerthat will call methods onUpdateFlowAliasRequest.Builderto create a request.- Returns:
- Result of the UpdateFlowAlias operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updateKnowledgeBase
default UpdateKnowledgeBaseResponse updateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UpdateKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateKnowledgeBase
default UpdateKnowledgeBaseResponse updateKnowledgeBase(Consumer<UpdateKnowledgeBaseRequest.Builder> updateKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException
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:
- Result of the UpdateKnowledgeBase operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
-
updatePrompt
default UpdatePromptResponse updatePrompt(UpdatePromptRequest updatePromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
- Parameters:
updatePromptRequest-- Returns:
- Result of the UpdatePrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
updatePrompt
default UpdatePromptResponse updatePrompt(Consumer<UpdatePromptRequest.Builder> updatePromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException
Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
UpdatePromptRequest.Builderavoiding the need to create one manually viaUpdatePromptRequest.builder()- Parameters:
updatePromptRequest- AConsumerthat will call methods onUpdatePromptRequest.Builderto create a request.- Returns:
- Result of the UpdatePrompt operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static BedrockAgentClient create()
Create aBedrockAgentClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static BedrockAgentClientBuilder builder()
Create a builder that can be used to configure and create aBedrockAgentClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default BedrockAgentServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-