Interface BedrockAgentClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Describes the API operations for creating and managing Amazon Bedrock agents.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionassociateAgentCollaborator
(Consumer<AssociateAgentCollaboratorRequest.Builder> associateAgentCollaboratorRequest) Makes an agent a collaborator for another agent.associateAgentCollaborator
(AssociateAgentCollaboratorRequest associateAgentCollaboratorRequest) Makes an agent a collaborator for another agent.associateAgentKnowledgeBase
(Consumer<AssociateAgentKnowledgeBaseRequest.Builder> associateAgentKnowledgeBaseRequest) Associates a knowledge base with an agent.associateAgentKnowledgeBase
(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest) Associates a knowledge base with an agent.static BedrockAgentClientBuilder
builder()
Create a builder that can be used to configure and create aBedrockAgentClient
.static BedrockAgentClient
create()
Create aBedrockAgentClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateAgentResponse
createAgent
(Consumer<CreateAgentRequest.Builder> createAgentRequest) Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.default CreateAgentResponse
createAgent
(CreateAgentRequest createAgentRequest) Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.default CreateAgentActionGroupResponse
createAgentActionGroup
(Consumer<CreateAgentActionGroupRequest.Builder> createAgentActionGroupRequest) Creates an action group for an agent.default CreateAgentActionGroupResponse
createAgentActionGroup
(CreateAgentActionGroupRequest createAgentActionGroupRequest) Creates an action group for an agent.default CreateAgentAliasResponse
createAgentAlias
(Consumer<CreateAgentAliasRequest.Builder> createAgentAliasRequest) Creates an alias of an agent that can be used to deploy the agent.default CreateAgentAliasResponse
createAgentAlias
(CreateAgentAliasRequest createAgentAliasRequest) Creates an alias of an agent that can be used to deploy the agent.default CreateDataSourceResponse
createDataSource
(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) Connects a knowledge base to a data source.default CreateDataSourceResponse
createDataSource
(CreateDataSourceRequest createDataSourceRequest) Connects a knowledge base to a data source.default CreateFlowResponse
createFlow
(Consumer<CreateFlowRequest.Builder> createFlowRequest) Creates a prompt flow that you can use to send an input through various steps to yield an output.default CreateFlowResponse
createFlow
(CreateFlowRequest createFlowRequest) Creates a prompt flow that you can use to send an input through various steps to yield an output.default CreateFlowAliasResponse
createFlowAlias
(Consumer<CreateFlowAliasRequest.Builder> createFlowAliasRequest) Creates an alias of a flow for deployment.default CreateFlowAliasResponse
createFlowAlias
(CreateFlowAliasRequest createFlowAliasRequest) Creates an alias of a flow for deployment.default CreateFlowVersionResponse
createFlowVersion
(Consumer<CreateFlowVersionRequest.Builder> createFlowVersionRequest) Creates a version of the flow that you can deploy.default CreateFlowVersionResponse
createFlowVersion
(CreateFlowVersionRequest createFlowVersionRequest) Creates a version of the flow that you can deploy.default CreateKnowledgeBaseResponse
createKnowledgeBase
(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) Creates a knowledge base.default CreateKnowledgeBaseResponse
createKnowledgeBase
(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Creates a knowledge base.default CreatePromptResponse
createPrompt
(Consumer<CreatePromptRequest.Builder> createPromptRequest) Creates a prompt in your prompt library that you can add to a flow.default CreatePromptResponse
createPrompt
(CreatePromptRequest createPromptRequest) Creates a prompt in your prompt library that you can add to a flow.default CreatePromptVersionResponse
createPromptVersion
(Consumer<CreatePromptVersionRequest.Builder> createPromptVersionRequest) Creates a static snapshot of your prompt that can be deployed to production.default CreatePromptVersionResponse
createPromptVersion
(CreatePromptVersionRequest createPromptVersionRequest) Creates a static snapshot of your prompt that can be deployed to production.default DeleteAgentResponse
deleteAgent
(Consumer<DeleteAgentRequest.Builder> deleteAgentRequest) Deletes an agent.default DeleteAgentResponse
deleteAgent
(DeleteAgentRequest deleteAgentRequest) Deletes an agent.default DeleteAgentActionGroupResponse
deleteAgentActionGroup
(Consumer<DeleteAgentActionGroupRequest.Builder> deleteAgentActionGroupRequest) Deletes an action group in an agent.default DeleteAgentActionGroupResponse
deleteAgentActionGroup
(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest) Deletes an action group in an agent.default DeleteAgentAliasResponse
deleteAgentAlias
(Consumer<DeleteAgentAliasRequest.Builder> deleteAgentAliasRequest) Deletes an alias of an agent.default DeleteAgentAliasResponse
deleteAgentAlias
(DeleteAgentAliasRequest deleteAgentAliasRequest) Deletes an alias of an agent.default DeleteAgentVersionResponse
deleteAgentVersion
(Consumer<DeleteAgentVersionRequest.Builder> deleteAgentVersionRequest) Deletes a version of an agent.default DeleteAgentVersionResponse
deleteAgentVersion
(DeleteAgentVersionRequest deleteAgentVersionRequest) Deletes a version of an agent.default DeleteDataSourceResponse
deleteDataSource
(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Deletes a data source from a knowledge base.default DeleteDataSourceResponse
deleteDataSource
(DeleteDataSourceRequest deleteDataSourceRequest) Deletes a data source from a knowledge base.default DeleteFlowResponse
deleteFlow
(Consumer<DeleteFlowRequest.Builder> deleteFlowRequest) Deletes a flow.default DeleteFlowResponse
deleteFlow
(DeleteFlowRequest deleteFlowRequest) Deletes a flow.default DeleteFlowAliasResponse
deleteFlowAlias
(Consumer<DeleteFlowAliasRequest.Builder> deleteFlowAliasRequest) Deletes an alias of a flow.default DeleteFlowAliasResponse
deleteFlowAlias
(DeleteFlowAliasRequest deleteFlowAliasRequest) Deletes an alias of a flow.default DeleteFlowVersionResponse
deleteFlowVersion
(Consumer<DeleteFlowVersionRequest.Builder> deleteFlowVersionRequest) Deletes a version of a flow.default DeleteFlowVersionResponse
deleteFlowVersion
(DeleteFlowVersionRequest deleteFlowVersionRequest) Deletes a version of a flow.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) Deletes a knowledge base.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes a knowledge base.deleteKnowledgeBaseDocuments
(Consumer<DeleteKnowledgeBaseDocumentsRequest.Builder> deleteKnowledgeBaseDocumentsRequest) Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it.deleteKnowledgeBaseDocuments
(DeleteKnowledgeBaseDocumentsRequest deleteKnowledgeBaseDocumentsRequest) Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it.default DeletePromptResponse
deletePrompt
(Consumer<DeletePromptRequest.Builder> deletePromptRequest) Deletes a prompt or a version of it, depending on whether you include thepromptVersion
field or not.default DeletePromptResponse
deletePrompt
(DeletePromptRequest deletePromptRequest) Deletes a prompt or a version of it, depending on whether you include thepromptVersion
field or not.disassociateAgentCollaborator
(Consumer<DisassociateAgentCollaboratorRequest.Builder> disassociateAgentCollaboratorRequest) Disassociates an agent collaborator.disassociateAgentCollaborator
(DisassociateAgentCollaboratorRequest disassociateAgentCollaboratorRequest) Disassociates an agent collaborator.disassociateAgentKnowledgeBase
(Consumer<DisassociateAgentKnowledgeBaseRequest.Builder> disassociateAgentKnowledgeBaseRequest) Disassociates a knowledge base from an agent.disassociateAgentKnowledgeBase
(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest) Disassociates a knowledge base from an agent.default GetAgentResponse
getAgent
(Consumer<GetAgentRequest.Builder> getAgentRequest) Gets information about an agent.default GetAgentResponse
getAgent
(GetAgentRequest getAgentRequest) Gets information about an agent.default GetAgentActionGroupResponse
getAgentActionGroup
(Consumer<GetAgentActionGroupRequest.Builder> getAgentActionGroupRequest) Gets information about an action group for an agent.default GetAgentActionGroupResponse
getAgentActionGroup
(GetAgentActionGroupRequest getAgentActionGroupRequest) Gets information about an action group for an agent.default GetAgentAliasResponse
getAgentAlias
(Consumer<GetAgentAliasRequest.Builder> getAgentAliasRequest) Gets information about an alias of an agent.default GetAgentAliasResponse
getAgentAlias
(GetAgentAliasRequest getAgentAliasRequest) Gets information about an alias of an agent.default GetAgentCollaboratorResponse
getAgentCollaborator
(Consumer<GetAgentCollaboratorRequest.Builder> getAgentCollaboratorRequest) Retrieves information about an agent's collaborator.default GetAgentCollaboratorResponse
getAgentCollaborator
(GetAgentCollaboratorRequest getAgentCollaboratorRequest) Retrieves information about an agent's collaborator.default GetAgentKnowledgeBaseResponse
getAgentKnowledgeBase
(Consumer<GetAgentKnowledgeBaseRequest.Builder> getAgentKnowledgeBaseRequest) Gets information about a knowledge base associated with an agent.default GetAgentKnowledgeBaseResponse
getAgentKnowledgeBase
(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest) Gets information about a knowledge base associated with an agent.default GetAgentVersionResponse
getAgentVersion
(Consumer<GetAgentVersionRequest.Builder> getAgentVersionRequest) Gets details about a version of an agent.default GetAgentVersionResponse
getAgentVersion
(GetAgentVersionRequest getAgentVersionRequest) Gets details about a version of an agent.default GetDataSourceResponse
getDataSource
(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) Gets information about a data source.default GetDataSourceResponse
getDataSource
(GetDataSourceRequest getDataSourceRequest) Gets information about a data source.default GetFlowResponse
getFlow
(Consumer<GetFlowRequest.Builder> getFlowRequest) Retrieves information about a flow.default GetFlowResponse
getFlow
(GetFlowRequest getFlowRequest) Retrieves information about a flow.default GetFlowAliasResponse
getFlowAlias
(Consumer<GetFlowAliasRequest.Builder> getFlowAliasRequest) Retrieves information about a flow.default GetFlowAliasResponse
getFlowAlias
(GetFlowAliasRequest getFlowAliasRequest) Retrieves information about a flow.default GetFlowVersionResponse
getFlowVersion
(Consumer<GetFlowVersionRequest.Builder> getFlowVersionRequest) Retrieves information about a version of a flow.default GetFlowVersionResponse
getFlowVersion
(GetFlowVersionRequest getFlowVersionRequest) Retrieves information about a version of a flow.default GetIngestionJobResponse
getIngestionJob
(Consumer<GetIngestionJobRequest.Builder> getIngestionJobRequest) Gets information about a data ingestion job.default GetIngestionJobResponse
getIngestionJob
(GetIngestionJobRequest getIngestionJobRequest) Gets information about a data ingestion job.default GetKnowledgeBaseResponse
getKnowledgeBase
(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) Gets information about a knoweldge base.default GetKnowledgeBaseResponse
getKnowledgeBase
(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Gets information about a knoweldge base.getKnowledgeBaseDocuments
(Consumer<GetKnowledgeBaseDocumentsRequest.Builder> getKnowledgeBaseDocumentsRequest) Retrieves specific documents from a data source that is connected to a knowledge base.getKnowledgeBaseDocuments
(GetKnowledgeBaseDocumentsRequest getKnowledgeBaseDocumentsRequest) Retrieves specific documents from a data source that is connected to a knowledge base.default GetPromptResponse
getPrompt
(Consumer<GetPromptRequest.Builder> getPromptRequest) Retrieves information about the working draft (DRAFT
version) of a prompt or a version of it, depending on whether you include thepromptVersion
field or not.default GetPromptResponse
getPrompt
(GetPromptRequest getPromptRequest) Retrieves information about the working draft (DRAFT
version) of a prompt or a version of it, depending on whether you include thepromptVersion
field or not.ingestKnowledgeBaseDocuments
(Consumer<IngestKnowledgeBaseDocumentsRequest.Builder> ingestKnowledgeBaseDocumentsRequest) Ingests documents directly into the knowledge base that is connected to the data source.ingestKnowledgeBaseDocuments
(IngestKnowledgeBaseDocumentsRequest ingestKnowledgeBaseDocumentsRequest) Ingests documents directly into the knowledge base that is connected to the data source.default ListAgentActionGroupsResponse
listAgentActionGroups
(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest) Lists the action groups for an agent and information about each one.default ListAgentActionGroupsResponse
listAgentActionGroups
(ListAgentActionGroupsRequest listAgentActionGroupsRequest) Lists the action groups for an agent and information about each one.default ListAgentActionGroupsIterable
listAgentActionGroupsPaginator
(Consumer<ListAgentActionGroupsRequest.Builder> listAgentActionGroupsRequest) This is a variant oflistAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)
operation.default ListAgentActionGroupsIterable
listAgentActionGroupsPaginator
(ListAgentActionGroupsRequest listAgentActionGroupsRequest) This is a variant oflistAgentActionGroups(software.amazon.awssdk.services.bedrockagent.model.ListAgentActionGroupsRequest)
operation.default ListAgentAliasesResponse
listAgentAliases
(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest) Lists the aliases of an agent and information about each one.default ListAgentAliasesResponse
listAgentAliases
(ListAgentAliasesRequest listAgentAliasesRequest) Lists the aliases of an agent and information about each one.default ListAgentAliasesIterable
listAgentAliasesPaginator
(Consumer<ListAgentAliasesRequest.Builder> listAgentAliasesRequest) This is a variant oflistAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)
operation.default ListAgentAliasesIterable
listAgentAliasesPaginator
(ListAgentAliasesRequest listAgentAliasesRequest) This is a variant oflistAgentAliases(software.amazon.awssdk.services.bedrockagent.model.ListAgentAliasesRequest)
operation.default ListAgentCollaboratorsResponse
listAgentCollaborators
(Consumer<ListAgentCollaboratorsRequest.Builder> listAgentCollaboratorsRequest) Retrieve a list of an agent's collaborators.default ListAgentCollaboratorsResponse
listAgentCollaborators
(ListAgentCollaboratorsRequest listAgentCollaboratorsRequest) Retrieve a list of an agent's collaborators.default ListAgentCollaboratorsIterable
listAgentCollaboratorsPaginator
(Consumer<ListAgentCollaboratorsRequest.Builder> listAgentCollaboratorsRequest) This is a variant oflistAgentCollaborators(software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsRequest)
operation.default ListAgentCollaboratorsIterable
listAgentCollaboratorsPaginator
(ListAgentCollaboratorsRequest listAgentCollaboratorsRequest) This is a variant oflistAgentCollaborators(software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsRequest)
operation.default ListAgentKnowledgeBasesResponse
listAgentKnowledgeBases
(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest) Lists knowledge bases associated with an agent and information about each one.default ListAgentKnowledgeBasesResponse
listAgentKnowledgeBases
(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest) Lists knowledge bases associated with an agent and information about each one.default ListAgentKnowledgeBasesIterable
listAgentKnowledgeBasesPaginator
(Consumer<ListAgentKnowledgeBasesRequest.Builder> listAgentKnowledgeBasesRequest) This is a variant oflistAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)
operation.default ListAgentKnowledgeBasesIterable
listAgentKnowledgeBasesPaginator
(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest) This is a variant oflistAgentKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListAgentKnowledgeBasesRequest)
operation.default ListAgentsResponse
listAgents
(Consumer<ListAgentsRequest.Builder> listAgentsRequest) Lists the agents belonging to an account and information about each agent.default ListAgentsResponse
listAgents
(ListAgentsRequest listAgentsRequest) Lists the agents belonging to an account and information about each agent.default ListAgentsIterable
listAgentsPaginator
(Consumer<ListAgentsRequest.Builder> listAgentsRequest) This is a variant oflistAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)
operation.default ListAgentsIterable
listAgentsPaginator
(ListAgentsRequest listAgentsRequest) This is a variant oflistAgents(software.amazon.awssdk.services.bedrockagent.model.ListAgentsRequest)
operation.default ListAgentVersionsResponse
listAgentVersions
(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest) Lists the versions of an agent and information about each version.default ListAgentVersionsResponse
listAgentVersions
(ListAgentVersionsRequest listAgentVersionsRequest) Lists the versions of an agent and information about each version.default ListAgentVersionsIterable
listAgentVersionsPaginator
(Consumer<ListAgentVersionsRequest.Builder> listAgentVersionsRequest) This is a variant oflistAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)
operation.default ListAgentVersionsIterable
listAgentVersionsPaginator
(ListAgentVersionsRequest listAgentVersionsRequest) This is a variant oflistAgentVersions(software.amazon.awssdk.services.bedrockagent.model.ListAgentVersionsRequest)
operation.default ListDataSourcesResponse
listDataSources
(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) Lists the data sources in a knowledge base and information about each one.default ListDataSourcesResponse
listDataSources
(ListDataSourcesRequest listDataSourcesRequest) Lists the data sources in a knowledge base and information about each one.default ListDataSourcesIterable
listDataSourcesPaginator
(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)
operation.default ListDataSourcesIterable
listDataSourcesPaginator
(ListDataSourcesRequest listDataSourcesRequest) This is a variant oflistDataSources(software.amazon.awssdk.services.bedrockagent.model.ListDataSourcesRequest)
operation.default ListFlowAliasesResponse
listFlowAliases
(Consumer<ListFlowAliasesRequest.Builder> listFlowAliasesRequest) Returns a list of aliases for a flow.default ListFlowAliasesResponse
listFlowAliases
(ListFlowAliasesRequest listFlowAliasesRequest) Returns a list of aliases for a flow.default ListFlowAliasesIterable
listFlowAliasesPaginator
(Consumer<ListFlowAliasesRequest.Builder> listFlowAliasesRequest) This is a variant oflistFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)
operation.default ListFlowAliasesIterable
listFlowAliasesPaginator
(ListFlowAliasesRequest listFlowAliasesRequest) This is a variant oflistFlowAliases(software.amazon.awssdk.services.bedrockagent.model.ListFlowAliasesRequest)
operation.default ListFlowsResponse
listFlows
(Consumer<ListFlowsRequest.Builder> listFlowsRequest) Returns a list of flows and information about each flow.default ListFlowsResponse
listFlows
(ListFlowsRequest listFlowsRequest) Returns a list of flows and information about each flow.default ListFlowsIterable
listFlowsPaginator
(Consumer<ListFlowsRequest.Builder> listFlowsRequest) This is a variant oflistFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)
operation.default ListFlowsIterable
listFlowsPaginator
(ListFlowsRequest listFlowsRequest) This is a variant oflistFlows(software.amazon.awssdk.services.bedrockagent.model.ListFlowsRequest)
operation.default ListFlowVersionsResponse
listFlowVersions
(Consumer<ListFlowVersionsRequest.Builder> listFlowVersionsRequest) Returns a list of information about each flow.default ListFlowVersionsResponse
listFlowVersions
(ListFlowVersionsRequest listFlowVersionsRequest) Returns a list of information about each flow.default ListFlowVersionsIterable
listFlowVersionsPaginator
(Consumer<ListFlowVersionsRequest.Builder> listFlowVersionsRequest) This is a variant oflistFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)
operation.default ListFlowVersionsIterable
listFlowVersionsPaginator
(ListFlowVersionsRequest listFlowVersionsRequest) This is a variant oflistFlowVersions(software.amazon.awssdk.services.bedrockagent.model.ListFlowVersionsRequest)
operation.default ListIngestionJobsResponse
listIngestionJobs
(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest) Lists the data ingestion jobs for a data source.default ListIngestionJobsResponse
listIngestionJobs
(ListIngestionJobsRequest listIngestionJobsRequest) Lists the data ingestion jobs for a data source.default ListIngestionJobsIterable
listIngestionJobsPaginator
(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest) This is a variant oflistIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)
operation.default ListIngestionJobsIterable
listIngestionJobsPaginator
(ListIngestionJobsRequest listIngestionJobsRequest) This is a variant oflistIngestionJobs(software.amazon.awssdk.services.bedrockagent.model.ListIngestionJobsRequest)
operation.listKnowledgeBaseDocuments
(Consumer<ListKnowledgeBaseDocumentsRequest.Builder> listKnowledgeBaseDocumentsRequest) Retrieves all the documents contained in a data source that is connected to a knowledge base.listKnowledgeBaseDocuments
(ListKnowledgeBaseDocumentsRequest listKnowledgeBaseDocumentsRequest) Retrieves all the documents contained in a data source that is connected to a knowledge base.listKnowledgeBaseDocumentsPaginator
(Consumer<ListKnowledgeBaseDocumentsRequest.Builder> listKnowledgeBaseDocumentsRequest) This is a variant oflistKnowledgeBaseDocuments(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest)
operation.listKnowledgeBaseDocumentsPaginator
(ListKnowledgeBaseDocumentsRequest listKnowledgeBaseDocumentsRequest) This is a variant oflistKnowledgeBaseDocuments(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest)
operation.default ListKnowledgeBasesResponse
listKnowledgeBases
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases in an account.default ListKnowledgeBasesResponse
listKnowledgeBases
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases in an account.default ListKnowledgeBasesIterable
listKnowledgeBasesPaginator
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)
operation.default ListKnowledgeBasesIterable
listKnowledgeBasesPaginator
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) This is a variant oflistKnowledgeBases(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBasesRequest)
operation.default ListPromptsResponse
listPrompts
(Consumer<ListPromptsRequest.Builder> listPromptsRequest) Returns either information about the working draft (DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifier
field or not.default ListPromptsResponse
listPrompts
(ListPromptsRequest listPromptsRequest) Returns either information about the working draft (DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifier
field or not.default ListPromptsIterable
listPromptsPaginator
(Consumer<ListPromptsRequest.Builder> listPromptsRequest) This is a variant oflistPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)
operation.default ListPromptsIterable
listPromptsPaginator
(ListPromptsRequest listPromptsRequest) This is a variant oflistPrompts(software.amazon.awssdk.services.bedrockagent.model.ListPromptsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List all the tags for the resource you specify.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List all the tags for the resource you specify.default PrepareAgentResponse
prepareAgent
(Consumer<PrepareAgentRequest.Builder> prepareAgentRequest) Creates aDRAFT
version of the agent that can be used for internal testing.default PrepareAgentResponse
prepareAgent
(PrepareAgentRequest prepareAgentRequest) Creates aDRAFT
version of the agent that can be used for internal testing.default PrepareFlowResponse
prepareFlow
(Consumer<PrepareFlowRequest.Builder> prepareFlowRequest) Prepares theDRAFT
version of a flow so that it can be invoked.default PrepareFlowResponse
prepareFlow
(PrepareFlowRequest prepareFlowRequest) Prepares theDRAFT
version of a flow so that it can be invoked.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartIngestionJobResponse
startIngestionJob
(Consumer<StartIngestionJobRequest.Builder> startIngestionJobRequest) Begins a data ingestion job.default StartIngestionJobResponse
startIngestionJob
(StartIngestionJobRequest startIngestionJobRequest) Begins a data ingestion job.default StopIngestionJobResponse
stopIngestionJob
(Consumer<StopIngestionJobRequest.Builder> stopIngestionJobRequest) Stops a currently running data ingestion job.default StopIngestionJobResponse
stopIngestionJob
(StopIngestionJobRequest stopIngestionJobRequest) Stops a currently running data ingestion job.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associate tags with a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Associate tags with a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Remove tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Remove tags from a resource.default UpdateAgentResponse
updateAgent
(Consumer<UpdateAgentRequest.Builder> updateAgentRequest) Updates the configuration of an agent.default UpdateAgentResponse
updateAgent
(UpdateAgentRequest updateAgentRequest) Updates the configuration of an agent.default UpdateAgentActionGroupResponse
updateAgentActionGroup
(Consumer<UpdateAgentActionGroupRequest.Builder> updateAgentActionGroupRequest) Updates the configuration for an action group for an agent.default UpdateAgentActionGroupResponse
updateAgentActionGroup
(UpdateAgentActionGroupRequest updateAgentActionGroupRequest) Updates the configuration for an action group for an agent.default UpdateAgentAliasResponse
updateAgentAlias
(Consumer<UpdateAgentAliasRequest.Builder> updateAgentAliasRequest) Updates configurations for an alias of an agent.default UpdateAgentAliasResponse
updateAgentAlias
(UpdateAgentAliasRequest updateAgentAliasRequest) Updates configurations for an alias of an agent.default UpdateAgentCollaboratorResponse
updateAgentCollaborator
(Consumer<UpdateAgentCollaboratorRequest.Builder> updateAgentCollaboratorRequest) Updates an agent's collaborator.default UpdateAgentCollaboratorResponse
updateAgentCollaborator
(UpdateAgentCollaboratorRequest updateAgentCollaboratorRequest) Updates an agent's collaborator.default UpdateAgentKnowledgeBaseResponse
updateAgentKnowledgeBase
(Consumer<UpdateAgentKnowledgeBaseRequest.Builder> updateAgentKnowledgeBaseRequest) Updates the configuration for a knowledge base that has been associated with an agent.default UpdateAgentKnowledgeBaseResponse
updateAgentKnowledgeBase
(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest) Updates the configuration for a knowledge base that has been associated with an agent.default UpdateDataSourceResponse
updateDataSource
(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates the configurations for a data source connector.default UpdateDataSourceResponse
updateDataSource
(UpdateDataSourceRequest updateDataSourceRequest) Updates the configurations for a data source connector.default UpdateFlowResponse
updateFlow
(Consumer<UpdateFlowRequest.Builder> updateFlowRequest) Modifies a flow.default UpdateFlowResponse
updateFlow
(UpdateFlowRequest updateFlowRequest) Modifies a flow.default UpdateFlowAliasResponse
updateFlowAlias
(Consumer<UpdateFlowAliasRequest.Builder> updateFlowAliasRequest) Modifies the alias of a flow.default UpdateFlowAliasResponse
updateFlowAlias
(UpdateFlowAliasRequest updateFlowAliasRequest) Modifies the alias of a flow.default UpdateKnowledgeBaseResponse
updateKnowledgeBase
(Consumer<UpdateKnowledgeBaseRequest.Builder> updateKnowledgeBaseRequest) Updates the configuration of a knowledge base with the fields that you specify.default UpdateKnowledgeBaseResponse
updateKnowledgeBase
(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest) Updates the configuration of a knowledge base with the fields that you specify.default UpdatePromptResponse
updatePrompt
(Consumer<UpdatePromptRequest.Builder> updatePromptRequest) Modifies a prompt in your prompt library.default UpdatePromptResponse
updatePrompt
(UpdatePromptRequest updatePromptRequest) Modifies a prompt in your prompt library.default ValidateFlowDefinitionResponse
validateFlowDefinition
(Consumer<ValidateFlowDefinitionRequest.Builder> validateFlowDefinitionRequest) Validates the definition of a flow.default ValidateFlowDefinitionResponse
validateFlowDefinition
(ValidateFlowDefinitionRequest validateFlowDefinitionRequest) Validates the definition of a flow.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateAgentCollaborator
default AssociateAgentCollaboratorResponse associateAgentCollaborator(AssociateAgentCollaboratorRequest associateAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Makes an agent a collaborator for another agent.
- Parameters:
associateAgentCollaboratorRequest
-- Returns:
- Result of the AssociateAgentCollaborator operation returned by the service.
- See Also:
-
associateAgentCollaborator
default AssociateAgentCollaboratorResponse associateAgentCollaborator(Consumer<AssociateAgentCollaboratorRequest.Builder> associateAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Makes an agent a collaborator for another agent.
This is a convenience which creates an instance of the
AssociateAgentCollaboratorRequest.Builder
avoiding the need to create one manually viaAssociateAgentCollaboratorRequest.builder()
- Parameters:
associateAgentCollaboratorRequest
- AConsumer
that will call methods onAssociateAgentCollaboratorRequest.Builder
to create a request.- Returns:
- Result of the AssociateAgentCollaborator operation returned by the service.
- See Also:
-
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
indexState
is 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.
- See Also:
-
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
indexState
is 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.Builder
avoiding the need to create one manually viaAssociateAgentKnowledgeBaseRequest.builder()
- Parameters:
associateAgentKnowledgeBaseRequest
- AConsumer
that will call methods onAssociateAgentKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the AssociateAgentKnowledgeBase operation returned by the service.
- See Also:
-
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 subsequentInvokeAgent
request begins a new session.
-
-
To enable your agent to retain conversational context across multiple sessions, include a
memoryConfiguration
object. For more information, see Configure memory. -
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts. -
If your agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for 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.
- See Also:
-
-
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 subsequentInvokeAgent
request begins a new session.
-
-
To enable your agent to retain conversational context across multiple sessions, include a
memoryConfiguration
object. For more information, see Configure memory. -
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts. -
If your agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for 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.Builder
avoiding the need to create one manually viaCreateAgentRequest.builder()
- Parameters:
createAgentRequest
- AConsumer
that will call methods onCreateAgentRequest.Builder
to create a request.- Returns:
- Result of the CreateAgent operation returned by the service.
- See Also:
-
-
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
parentActionGroupSignature
field 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
parentActionGroupSignature
field set toAMAZON.CodeInterpreter
.You must leave the
description
,apiSchema
, andactionGroupExecutor
fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.- Parameters:
createAgentActionGroupRequest
-- Returns:
- Result of the CreateAgentActionGroup operation returned by the service.
- See Also:
-
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
parentActionGroupSignature
field 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
parentActionGroupSignature
field set toAMAZON.CodeInterpreter
.You must leave the
description
,apiSchema
, andactionGroupExecutor
fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
This is a convenience which creates an instance of the
CreateAgentActionGroupRequest.Builder
avoiding the need to create one manually viaCreateAgentActionGroupRequest.builder()
- Parameters:
createAgentActionGroupRequest
- AConsumer
that will call methods onCreateAgentActionGroupRequest.Builder
to create a request.- Returns:
- Result of the CreateAgentActionGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateAgentAliasRequest.builder()
- Parameters:
createAgentAliasRequest
- AConsumer
that will call methods onCreateAgentAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateAgentAlias operation returned by the service.
- See Also:
-
createDataSource
default CreateDataSourceResponse createDataSource(CreateDataSourceRequest createDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the
dataSourceConfiguration
field.You can't change the
chunkingConfiguration
after you create the data source connector.- Parameters:
createDataSourceRequest
-- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
createDataSource
default CreateDataSourceResponse createDataSource(Consumer<CreateDataSourceRequest.Builder> createDataSourceRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the
dataSourceConfiguration
field.You can't change the
chunkingConfiguration
after you create the data source connector.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builder
avoiding the need to create one manually viaCreateDataSourceRequest.builder()
- Parameters:
createDataSourceRequest
- AConsumer
that will call methods onCreateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the CreateDataSource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateFlowRequest.builder()
- Parameters:
createFlowRequest
- AConsumer
that will call methods onCreateFlowRequest.Builder
to create a request.- Returns:
- Result of the CreateFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateFlowAliasRequest.builder()
- Parameters:
createFlowAliasRequest
- AConsumer
that will call methods onCreateFlowAliasRequest.Builder
to create a request.- Returns:
- Result of the CreateFlowAlias operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreateFlowVersionRequest.builder()
- Parameters:
createFlowVersionRequest
- AConsumer
that will call methods onCreateFlowVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateFlowVersion operation returned by the service.
- See Also:
-
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
name
and an optionaldescription
. -
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the
roleArn
field. -
Provide the embedding model to use in the
embeddingModelArn
field in theknowledgeBaseConfiguration
object. -
Provide the configuration for your vector store in the
storageConfiguration
object.-
For an Amazon OpenSearch Service database, use the
opensearchServerlessConfiguration
object. For more information, see Create a vector store in Amazon OpenSearch Service. -
For an Amazon Aurora database, use the
RdsConfiguration
object. For more information, see Create a vector store in Amazon Aurora. -
For a Pinecone database, use the
pineconeConfiguration
object. For more information, see Create a vector store in Pinecone. -
For a Redis Enterprise Cloud database, use the
redisEnterpriseCloudConfiguration
object. For more information, see Create a vector store in Redis Enterprise Cloud.
-
- Parameters:
createKnowledgeBaseRequest
-- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- See Also:
-
-
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
name
and an optionaldescription
. -
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the
roleArn
field. -
Provide the embedding model to use in the
embeddingModelArn
field in theknowledgeBaseConfiguration
object. -
Provide the configuration for your vector store in the
storageConfiguration
object.-
For an Amazon OpenSearch Service database, use the
opensearchServerlessConfiguration
object. For more information, see Create a vector store in Amazon OpenSearch Service. -
For an Amazon Aurora database, use the
RdsConfiguration
object. For more information, see Create a vector store in Amazon Aurora. -
For a Pinecone database, use the
pineconeConfiguration
object. For more information, see Create a vector store in Pinecone. -
For a Redis Enterprise Cloud database, use the
redisEnterpriseCloudConfiguration
object. For more information, see Create a vector store in Redis Enterprise Cloud.
-
This is a convenience which creates an instance of the
CreateKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaCreateKnowledgeBaseRequest.builder()
- Parameters:
createKnowledgeBaseRequest
- AConsumer
that will call methods onCreateKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the CreateKnowledgeBase operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreatePromptRequest.builder()
- Parameters:
createPromptRequest
- AConsumer
that will call methods onCreatePromptRequest.Builder
to create a request.- Returns:
- Result of the CreatePrompt operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaCreatePromptVersionRequest.builder()
- Parameters:
createPromptVersionRequest
- AConsumer
that will call methods onCreatePromptVersionRequest.Builder
to create a request.- Returns:
- Result of the CreatePromptVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteAgentRequest.builder()
- Parameters:
deleteAgentRequest
- AConsumer
that will call methods onDeleteAgentRequest.Builder
to create a request.- Returns:
- Result of the DeleteAgent operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteAgentActionGroupRequest.builder()
- Parameters:
deleteAgentActionGroupRequest
- AConsumer
that will call methods onDeleteAgentActionGroupRequest.Builder
to create a request.- Returns:
- Result of the DeleteAgentActionGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteAgentAliasRequest.builder()
- Parameters:
deleteAgentAliasRequest
- AConsumer
that will call methods onDeleteAgentAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteAgentAlias operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteAgentVersionRequest.builder()
- Parameters:
deleteAgentVersionRequest
- AConsumer
that will call methods onDeleteAgentVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteAgentVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteDataSourceRequest.builder()
- Parameters:
deleteDataSourceRequest
- AConsumer
that will call methods onDeleteDataSourceRequest.Builder
to create a request.- Returns:
- Result of the DeleteDataSource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteFlowRequest.builder()
- Parameters:
deleteFlowRequest
- AConsumer
that will call methods onDeleteFlowRequest.Builder
to create a request.- Returns:
- Result of the DeleteFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteFlowAliasRequest.builder()
- Parameters:
deleteFlowAliasRequest
- AConsumer
that will call methods onDeleteFlowAliasRequest.Builder
to create a request.- Returns:
- Result of the DeleteFlowAlias operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteFlowVersionRequest.builder()
- Parameters:
deleteFlowVersionRequest
- AConsumer
that will call methods onDeleteFlowVersionRequest.Builder
to create a request.- Returns:
- Result of the DeleteFlowVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDeleteKnowledgeBaseRequest.builder()
- Parameters:
deleteKnowledgeBaseRequest
- AConsumer
that will call methods onDeleteKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the DeleteKnowledgeBase operation returned by the service.
- See Also:
-
deleteKnowledgeBaseDocuments
default DeleteKnowledgeBaseDocumentsResponse deleteKnowledgeBaseDocuments(DeleteKnowledgeBaseDocumentsRequest deleteKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
- Parameters:
deleteKnowledgeBaseDocumentsRequest
-- Returns:
- Result of the DeleteKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
deleteKnowledgeBaseDocuments
default DeleteKnowledgeBaseDocumentsResponse deleteKnowledgeBaseDocuments(Consumer<DeleteKnowledgeBaseDocumentsRequest.Builder> deleteKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
DeleteKnowledgeBaseDocumentsRequest.Builder
avoiding the need to create one manually viaDeleteKnowledgeBaseDocumentsRequest.builder()
- Parameters:
deleteKnowledgeBaseDocumentsRequest
- AConsumer
that will call methods onDeleteKnowledgeBaseDocumentsRequest.Builder
to create a request.- Returns:
- Result of the DeleteKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
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
promptVersion
field 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.
- See Also:
-
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
promptVersion
field 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.Builder
avoiding the need to create one manually viaDeletePromptRequest.builder()
- Parameters:
deletePromptRequest
- AConsumer
that will call methods onDeletePromptRequest.Builder
to create a request.- Returns:
- Result of the DeletePrompt operation returned by the service.
- See Also:
-
disassociateAgentCollaborator
default DisassociateAgentCollaboratorResponse disassociateAgentCollaborator(DisassociateAgentCollaboratorRequest disassociateAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException Disassociates an agent collaborator.
- Parameters:
disassociateAgentCollaboratorRequest
-- Returns:
- Result of the DisassociateAgentCollaborator operation returned by the service.
- See Also:
-
disassociateAgentCollaborator
default DisassociateAgentCollaboratorResponse disassociateAgentCollaborator(Consumer<DisassociateAgentCollaboratorRequest.Builder> disassociateAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, BedrockAgentException Disassociates an agent collaborator.
This is a convenience which creates an instance of the
DisassociateAgentCollaboratorRequest.Builder
avoiding the need to create one manually viaDisassociateAgentCollaboratorRequest.builder()
- Parameters:
disassociateAgentCollaboratorRequest
- AConsumer
that will call methods onDisassociateAgentCollaboratorRequest.Builder
to create a request.- Returns:
- Result of the DisassociateAgentCollaborator operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaDisassociateAgentKnowledgeBaseRequest.builder()
- Parameters:
disassociateAgentKnowledgeBaseRequest
- AConsumer
that will call methods onDisassociateAgentKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the DisassociateAgentKnowledgeBase operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetAgentRequest.builder()
- Parameters:
getAgentRequest
- AConsumer
that will call methods onGetAgentRequest.Builder
to create a request.- Returns:
- Result of the GetAgent operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetAgentActionGroupRequest.builder()
- Parameters:
getAgentActionGroupRequest
- AConsumer
that will call methods onGetAgentActionGroupRequest.Builder
to create a request.- Returns:
- Result of the GetAgentActionGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetAgentAliasRequest.builder()
- Parameters:
getAgentAliasRequest
- AConsumer
that will call methods onGetAgentAliasRequest.Builder
to create a request.- Returns:
- Result of the GetAgentAlias operation returned by the service.
- See Also:
-
getAgentCollaborator
default GetAgentCollaboratorResponse getAgentCollaborator(GetAgentCollaboratorRequest getAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves information about an agent's collaborator.
- Parameters:
getAgentCollaboratorRequest
-- Returns:
- Result of the GetAgentCollaborator operation returned by the service.
- See Also:
-
getAgentCollaborator
default GetAgentCollaboratorResponse getAgentCollaborator(Consumer<GetAgentCollaboratorRequest.Builder> getAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves information about an agent's collaborator.
This is a convenience which creates an instance of the
GetAgentCollaboratorRequest.Builder
avoiding the need to create one manually viaGetAgentCollaboratorRequest.builder()
- Parameters:
getAgentCollaboratorRequest
- AConsumer
that will call methods onGetAgentCollaboratorRequest.Builder
to create a request.- Returns:
- Result of the GetAgentCollaborator operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetAgentKnowledgeBaseRequest.builder()
- Parameters:
getAgentKnowledgeBaseRequest
- AConsumer
that will call methods onGetAgentKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the GetAgentKnowledgeBase operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetAgentVersionRequest.builder()
- Parameters:
getAgentVersionRequest
- AConsumer
that will call methods onGetAgentVersionRequest.Builder
to create a request.- Returns:
- Result of the GetAgentVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetDataSourceRequest.builder()
- Parameters:
getDataSourceRequest
- AConsumer
that will call methods onGetDataSourceRequest.Builder
to create a request.- Returns:
- Result of the GetDataSource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetFlowRequest.builder()
- Parameters:
getFlowRequest
- AConsumer
that will call methods onGetFlowRequest.Builder
to create a request.- Returns:
- Result of the GetFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetFlowAliasRequest.builder()
- Parameters:
getFlowAliasRequest
- AConsumer
that will call methods onGetFlowAliasRequest.Builder
to create a request.- Returns:
- Result of the GetFlowAlias operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetFlowVersionRequest.builder()
- Parameters:
getFlowVersionRequest
- AConsumer
that will call methods onGetFlowVersionRequest.Builder
to create a request.- Returns:
- Result of the GetFlowVersion operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetIngestionJobRequest.builder()
- Parameters:
getIngestionJobRequest
- AConsumer
that will call methods onGetIngestionJobRequest.Builder
to create a request.- Returns:
- Result of the GetIngestionJob operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaGetKnowledgeBaseRequest.builder()
- Parameters:
getKnowledgeBaseRequest
- AConsumer
that will call methods onGetKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the GetKnowledgeBase operation returned by the service.
- See Also:
-
getKnowledgeBaseDocuments
default GetKnowledgeBaseDocumentsResponse getKnowledgeBaseDocuments(GetKnowledgeBaseDocumentsRequest getKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
- Parameters:
getKnowledgeBaseDocumentsRequest
-- Returns:
- Result of the GetKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
getKnowledgeBaseDocuments
default GetKnowledgeBaseDocumentsResponse getKnowledgeBaseDocuments(Consumer<GetKnowledgeBaseDocumentsRequest.Builder> getKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
GetKnowledgeBaseDocumentsRequest.Builder
avoiding the need to create one manually viaGetKnowledgeBaseDocumentsRequest.builder()
- Parameters:
getKnowledgeBaseDocumentsRequest
- AConsumer
that will call methods onGetKnowledgeBaseDocumentsRequest.Builder
to create a request.- Returns:
- Result of the GetKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
getPrompt
default GetPromptResponse getPrompt(GetPromptRequest getPromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves information about the working draft (
DRAFT
version) of a prompt or a version of it, depending on whether you include thepromptVersion
field 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.
- See Also:
-
getPrompt
default GetPromptResponse getPrompt(Consumer<GetPromptRequest.Builder> getPromptRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves information about the working draft (
DRAFT
version) of a prompt or a version of it, depending on whether you include thepromptVersion
field 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.Builder
avoiding the need to create one manually viaGetPromptRequest.builder()
- Parameters:
getPromptRequest
- AConsumer
that will call methods onGetPromptRequest.Builder
to create a request.- Returns:
- Result of the GetPrompt operation returned by the service.
- See Also:
-
ingestKnowledgeBaseDocuments
default IngestKnowledgeBaseDocumentsResponse ingestKnowledgeBaseDocuments(IngestKnowledgeBaseDocumentsRequest ingestKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Ingests documents directly into the knowledge base that is connected to the data source. The
dataSourceType
specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.- Parameters:
ingestKnowledgeBaseDocumentsRequest
-- Returns:
- Result of the IngestKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
ingestKnowledgeBaseDocuments
default IngestKnowledgeBaseDocumentsResponse ingestKnowledgeBaseDocuments(Consumer<IngestKnowledgeBaseDocumentsRequest.Builder> ingestKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Ingests documents directly into the knowledge base that is connected to the data source. The
dataSourceType
specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
IngestKnowledgeBaseDocumentsRequest.Builder
avoiding the need to create one manually viaIngestKnowledgeBaseDocumentsRequest.builder()
- Parameters:
ingestKnowledgeBaseDocumentsRequest
- AConsumer
that will call methods onIngestKnowledgeBaseDocumentsRequest.Builder
to create a request.- Returns:
- Result of the IngestKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListAgentActionGroupsRequest.builder()
- Parameters:
listAgentActionGroupsRequest
- AConsumer
that will call methods onListAgentActionGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListAgentActionGroups operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAgentActionGroupsRequest.builder()
- Parameters:
listAgentActionGroupsRequest
- AConsumer
that will call methods onListAgentActionGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListAgentAliasesRequest.builder()
- Parameters:
listAgentAliasesRequest
- AConsumer
that will call methods onListAgentAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListAgentAliases operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAgentAliasesRequest.builder()
- Parameters:
listAgentAliasesRequest
- AConsumer
that will call methods onListAgentAliasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAgentCollaborators
default ListAgentCollaboratorsResponse listAgentCollaborators(ListAgentCollaboratorsRequest listAgentCollaboratorsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Retrieve a list of an agent's collaborators.
- Parameters:
listAgentCollaboratorsRequest
-- Returns:
- Result of the ListAgentCollaborators operation returned by the service.
- See Also:
-
listAgentCollaborators
default ListAgentCollaboratorsResponse listAgentCollaborators(Consumer<ListAgentCollaboratorsRequest.Builder> listAgentCollaboratorsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Retrieve a list of an agent's collaborators.
This is a convenience which creates an instance of the
ListAgentCollaboratorsRequest.Builder
avoiding the need to create one manually viaListAgentCollaboratorsRequest.builder()
- Parameters:
listAgentCollaboratorsRequest
- AConsumer
that will call methods onListAgentCollaboratorsRequest.Builder
to create a request.- Returns:
- Result of the ListAgentCollaborators operation returned by the service.
- See Also:
-
listAgentCollaboratorsPaginator
default ListAgentCollaboratorsIterable listAgentCollaboratorsPaginator(ListAgentCollaboratorsRequest listAgentCollaboratorsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException This is a variant of
listAgentCollaborators(software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsRequest)
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 Streamsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentCollaboratorsIterable responses = client.listAgentCollaboratorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentCollaboratorsIterable responses = client .listAgentCollaboratorsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentCollaboratorsIterable responses = client.listAgentCollaboratorsPaginator(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
listAgentCollaborators(software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsRequest)
operation.- Parameters:
listAgentCollaboratorsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAgentCollaboratorsPaginator
default ListAgentCollaboratorsIterable listAgentCollaboratorsPaginator(Consumer<ListAgentCollaboratorsRequest.Builder> listAgentCollaboratorsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException This is a variant of
listAgentCollaborators(software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsRequest)
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 Streamsoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentCollaboratorsIterable responses = client.listAgentCollaboratorsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListAgentCollaboratorsIterable responses = client .listAgentCollaboratorsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListAgentCollaboratorsIterable responses = client.listAgentCollaboratorsPaginator(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
listAgentCollaborators(software.amazon.awssdk.services.bedrockagent.model.ListAgentCollaboratorsRequest)
operation.
This is a convenience which creates an instance of the
ListAgentCollaboratorsRequest.Builder
avoiding the need to create one manually viaListAgentCollaboratorsRequest.builder()
- Parameters:
listAgentCollaboratorsRequest
- AConsumer
that will call methods onListAgentCollaboratorsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListAgentKnowledgeBasesRequest.builder()
- Parameters:
listAgentKnowledgeBasesRequest
- AConsumer
that will call methods onListAgentKnowledgeBasesRequest.Builder
to create a request.- Returns:
- Result of the ListAgentKnowledgeBases operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAgentKnowledgeBasesRequest.builder()
- Parameters:
listAgentKnowledgeBasesRequest
- AConsumer
that will call methods onListAgentKnowledgeBasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListAgentVersionsRequest.builder()
- Parameters:
listAgentVersionsRequest
- AConsumer
that will call methods onListAgentVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListAgentVersions operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAgentVersionsRequest.builder()
- Parameters:
listAgentVersionsRequest
- AConsumer
that will call methods onListAgentVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListAgentsRequest.builder()
- Parameters:
listAgentsRequest
- AConsumer
that will call methods onListAgentsRequest.Builder
to create a request.- Returns:
- Result of the ListAgents operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListAgentsRequest.builder()
- Parameters:
listAgentsRequest
- AConsumer
that will call methods onListAgentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListDataSources operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListDataSourcesRequest.builder()
- Parameters:
listDataSourcesRequest
- AConsumer
that will call methods onListDataSourcesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListFlowAliasesRequest.builder()
- Parameters:
listFlowAliasesRequest
- AConsumer
that will call methods onListFlowAliasesRequest.Builder
to create a request.- Returns:
- Result of the ListFlowAliases operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListFlowAliasesRequest.builder()
- Parameters:
listFlowAliasesRequest
- AConsumer
that will call methods onListFlowAliasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListFlowVersionsRequest.builder()
- Parameters:
listFlowVersionsRequest
- AConsumer
that will call methods onListFlowVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListFlowVersions operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListFlowVersionsRequest.builder()
- Parameters:
listFlowVersionsRequest
- AConsumer
that will call methods onListFlowVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListFlowsRequest.builder()
- Parameters:
listFlowsRequest
- AConsumer
that will call methods onListFlowsRequest.Builder
to create a request.- Returns:
- Result of the ListFlows operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListFlowsRequest.builder()
- Parameters:
listFlowsRequest
- AConsumer
that will call methods onListFlowsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListIngestionJobsRequest.builder()
- Parameters:
listIngestionJobsRequest
- AConsumer
that will call methods onListIngestionJobsRequest.Builder
to create a request.- Returns:
- Result of the ListIngestionJobs operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListIngestionJobsRequest.builder()
- Parameters:
listIngestionJobsRequest
- AConsumer
that will call methods onListIngestionJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKnowledgeBaseDocuments
default ListKnowledgeBaseDocumentsResponse listKnowledgeBaseDocuments(ListKnowledgeBaseDocumentsRequest listKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
- Parameters:
listKnowledgeBaseDocumentsRequest
-- Returns:
- Result of the ListKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
listKnowledgeBaseDocuments
default ListKnowledgeBaseDocumentsResponse listKnowledgeBaseDocuments(Consumer<ListKnowledgeBaseDocumentsRequest.Builder> listKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.
This is a convenience which creates an instance of the
ListKnowledgeBaseDocumentsRequest.Builder
avoiding the need to create one manually viaListKnowledgeBaseDocumentsRequest.builder()
- Parameters:
listKnowledgeBaseDocumentsRequest
- AConsumer
that will call methods onListKnowledgeBaseDocumentsRequest.Builder
to create a request.- Returns:
- Result of the ListKnowledgeBaseDocuments operation returned by the service.
- See Also:
-
listKnowledgeBaseDocumentsPaginator
default ListKnowledgeBaseDocumentsIterable listKnowledgeBaseDocumentsPaginator(ListKnowledgeBaseDocumentsRequest listKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException This is a variant of
listKnowledgeBaseDocuments(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest)
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 Streamsoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBaseDocumentsIterable responses = client.listKnowledgeBaseDocumentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBaseDocumentsIterable responses = client .listKnowledgeBaseDocumentsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBaseDocumentsIterable responses = client.listKnowledgeBaseDocumentsPaginator(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
listKnowledgeBaseDocuments(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest)
operation.- Parameters:
listKnowledgeBaseDocumentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listKnowledgeBaseDocumentsPaginator
default ListKnowledgeBaseDocumentsIterable listKnowledgeBaseDocumentsPaginator(Consumer<ListKnowledgeBaseDocumentsRequest.Builder> listKnowledgeBaseDocumentsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException This is a variant of
listKnowledgeBaseDocuments(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest)
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 Streamsoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBaseDocumentsIterable responses = client.listKnowledgeBaseDocumentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBaseDocumentsIterable responses = client .listKnowledgeBaseDocumentsPaginator(request); for (software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.bedrockagent.paginators.ListKnowledgeBaseDocumentsIterable responses = client.listKnowledgeBaseDocumentsPaginator(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
listKnowledgeBaseDocuments(software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest)
operation.
This is a convenience which creates an instance of the
ListKnowledgeBaseDocumentsRequest.Builder
avoiding the need to create one manually viaListKnowledgeBaseDocumentsRequest.builder()
- Parameters:
listKnowledgeBaseDocumentsRequest
- AConsumer
that will call methods onListKnowledgeBaseDocumentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListKnowledgeBasesRequest.builder()
- Parameters:
listKnowledgeBasesRequest
- AConsumer
that will call methods onListKnowledgeBasesRequest.Builder
to create a request.- Returns:
- Result of the ListKnowledgeBases operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListKnowledgeBasesRequest.builder()
- Parameters:
listKnowledgeBasesRequest
- AConsumer
that will call methods onListKnowledgeBasesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPrompts
default ListPromptsResponse listPrompts(ListPromptsRequest listPromptsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Returns either information about the working draft (
DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifier
field 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.
- See Also:
-
listPrompts
default ListPromptsResponse listPrompts(Consumer<ListPromptsRequest.Builder> listPromptsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Returns either information about the working draft (
DRAFT
version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include thepromptIdentifier
field 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.Builder
avoiding the need to create one manually viaListPromptsRequest.builder()
- Parameters:
listPromptsRequest
- AConsumer
that will call methods onListPromptsRequest.Builder
to create a request.- Returns:
- Result of the ListPrompts operation returned by the service.
- See Also:
-
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 Streamsoftware.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.
- See Also:
-
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 Streamsoftware.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.Builder
avoiding the need to create one manually viaListPromptsRequest.builder()
- Parameters:
listPromptsRequest
- AConsumer
that will call methods onListPromptsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
prepareAgent
default PrepareAgentResponse prepareAgent(PrepareAgentRequest prepareAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Creates a
DRAFT
version of the agent that can be used for internal testing.- Parameters:
prepareAgentRequest
-- Returns:
- Result of the PrepareAgent operation returned by the service.
- See Also:
-
prepareAgent
default PrepareAgentResponse prepareAgent(Consumer<PrepareAgentRequest.Builder> prepareAgentRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Creates a
DRAFT
version of the agent that can be used for internal testing.
This is a convenience which creates an instance of the
PrepareAgentRequest.Builder
avoiding the need to create one manually viaPrepareAgentRequest.builder()
- Parameters:
prepareAgentRequest
- AConsumer
that will call methods onPrepareAgentRequest.Builder
to create a request.- Returns:
- Result of the PrepareAgent operation returned by the service.
- See Also:
-
prepareFlow
default PrepareFlowResponse prepareFlow(PrepareFlowRequest prepareFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Prepares the
DRAFT
version 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.
- See Also:
-
prepareFlow
default PrepareFlowResponse prepareFlow(Consumer<PrepareFlowRequest.Builder> prepareFlowRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Prepares the
DRAFT
version 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.Builder
avoiding the need to create one manually viaPrepareFlowRequest.builder()
- Parameters:
prepareFlowRequest
- AConsumer
that will call methods onPrepareFlowRequest.Builder
to create a request.- Returns:
- Result of the PrepareFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaStartIngestionJobRequest.builder()
- Parameters:
startIngestionJobRequest
- AConsumer
that will call methods onStartIngestionJobRequest.Builder
to create a request.- Returns:
- Result of the StartIngestionJob operation returned by the service.
- See Also:
-
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
StartIngestionJob
request again to ingest the rest of your data when you are ready.- Parameters:
stopIngestionJobRequest
-- Returns:
- Result of the StopIngestionJob operation returned by the service.
- See Also:
-
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
StartIngestionJob
request again to ingest the rest of your data when you are ready.
This is a convenience which creates an instance of the
StopIngestionJobRequest.Builder
avoiding the need to create one manually viaStopIngestionJobRequest.builder()
- Parameters:
stopIngestionJobRequest
- AConsumer
that will call methods onStopIngestionJobRequest.Builder
to create a request.- Returns:
- Result of the StopIngestionJob operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateAgentRequest.builder()
- Parameters:
updateAgentRequest
- AConsumer
that will call methods onUpdateAgentRequest.Builder
to create a request.- Returns:
- Result of the UpdateAgent operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateAgentActionGroupRequest.builder()
- Parameters:
updateAgentActionGroupRequest
- AConsumer
that will call methods onUpdateAgentActionGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdateAgentActionGroup operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateAgentAliasRequest.builder()
- Parameters:
updateAgentAliasRequest
- AConsumer
that will call methods onUpdateAgentAliasRequest.Builder
to create a request.- Returns:
- Result of the UpdateAgentAlias operation returned by the service.
- See Also:
-
updateAgentCollaborator
default UpdateAgentCollaboratorResponse updateAgentCollaborator(UpdateAgentCollaboratorRequest updateAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Updates an agent's collaborator.
- Parameters:
updateAgentCollaboratorRequest
-- Returns:
- Result of the UpdateAgentCollaborator operation returned by the service.
- See Also:
-
updateAgentCollaborator
default UpdateAgentCollaboratorResponse updateAgentCollaborator(Consumer<UpdateAgentCollaboratorRequest.Builder> updateAgentCollaboratorRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Updates an agent's collaborator.
This is a convenience which creates an instance of the
UpdateAgentCollaboratorRequest.Builder
avoiding the need to create one manually viaUpdateAgentCollaboratorRequest.builder()
- Parameters:
updateAgentCollaboratorRequest
- AConsumer
that will call methods onUpdateAgentCollaboratorRequest.Builder
to create a request.- Returns:
- Result of the UpdateAgentCollaborator operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateAgentKnowledgeBaseRequest.builder()
- Parameters:
updateAgentKnowledgeBaseRequest
- AConsumer
that will call methods onUpdateAgentKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the UpdateAgentKnowledgeBase operation returned by the service.
- See Also:
-
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
chunkingConfiguration
after you create the data source connector. Specify the existingchunkingConfiguration
.- Parameters:
updateDataSourceRequest
-- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
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
chunkingConfiguration
after you create the data source connector. Specify the existingchunkingConfiguration
.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builder
avoiding the need to create one manually viaUpdateDataSourceRequest.builder()
- Parameters:
updateDataSourceRequest
- AConsumer
that will call methods onUpdateDataSourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateDataSource operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateFlowRequest.builder()
- Parameters:
updateFlowRequest
- AConsumer
that will call methods onUpdateFlowRequest.Builder
to create a request.- Returns:
- Result of the UpdateFlow operation returned by the service.
- See Also:
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdateFlowAliasRequest.builder()
- Parameters:
updateFlowAliasRequest
- AConsumer
that will call methods onUpdateFlowAliasRequest.Builder
to create a request.- Returns:
- Result of the UpdateFlowAlias operation returned by the service.
- See Also:
-
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
knowledgeBaseConfiguration
orstorageConfiguration
fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.- Parameters:
updateKnowledgeBaseRequest
-- Returns:
- Result of the UpdateKnowledgeBase operation returned by the service.
- See Also:
-
-
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
knowledgeBaseConfiguration
orstorageConfiguration
fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
This is a convenience which creates an instance of the
UpdateKnowledgeBaseRequest.Builder
avoiding the need to create one manually viaUpdateKnowledgeBaseRequest.builder()
- Parameters:
updateKnowledgeBaseRequest
- AConsumer
that will call methods onUpdateKnowledgeBaseRequest.Builder
to create a request.- Returns:
- Result of the UpdateKnowledgeBase operation returned by the service.
- See Also:
-
-
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.
- See Also:
-
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.Builder
avoiding the need to create one manually viaUpdatePromptRequest.builder()
- Parameters:
updatePromptRequest
- AConsumer
that will call methods onUpdatePromptRequest.Builder
to create a request.- Returns:
- Result of the UpdatePrompt operation returned by the service.
- See Also:
-
validateFlowDefinition
default ValidateFlowDefinitionResponse validateFlowDefinition(ValidateFlowDefinitionRequest validateFlowDefinitionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException Validates the definition of a flow.
- Parameters:
validateFlowDefinitionRequest
-- Returns:
- Result of the ValidateFlowDefinition operation returned by the service.
- See Also:
-
validateFlowDefinition
default ValidateFlowDefinitionResponse validateFlowDefinition(Consumer<ValidateFlowDefinitionRequest.Builder> validateFlowDefinitionRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException Validates the definition of a flow.
This is a convenience which creates an instance of the
ValidateFlowDefinitionRequest.Builder
avoiding the need to create one manually viaValidateFlowDefinitionRequest.builder()
- Parameters:
validateFlowDefinitionRequest
- AConsumer
that will call methods onValidateFlowDefinitionRequest.Builder
to create a request.- Returns:
- Result of the ValidateFlowDefinition operation returned by the service.
- See Also:
-
create
Create aBedrockAgentClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aBedrockAgentClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-