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 TypeMethodDescriptionassociateAgentKnowledgeBase
(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) Sets up a data source to be added to a knowledge base.default CreateDataSourceResponse
createDataSource
(CreateDataSourceRequest createDataSourceRequest) Sets up a data source to be added to a knowledge base.default CreateKnowledgeBaseResponse
createKnowledgeBase
(Consumer<CreateKnowledgeBaseRequest.Builder> createKnowledgeBaseRequest) Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.default CreateKnowledgeBaseResponse
createKnowledgeBase
(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.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 DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(Consumer<DeleteKnowledgeBaseRequest.Builder> deleteKnowledgeBaseRequest) Deletes a knowledge base.default DeleteKnowledgeBaseResponse
deleteKnowledgeBase
(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes a knowledge base.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 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 GetIngestionJobResponse
getIngestionJob
(Consumer<GetIngestionJobRequest.Builder> getIngestionJobRequest) Gets information about a ingestion job, in which a data source is added to a knowledge base.default GetIngestionJobResponse
getIngestionJob
(GetIngestionJobRequest getIngestionJobRequest) Gets information about a ingestion job, in which a data source is added to a knowledge base.default GetKnowledgeBaseResponse
getKnowledgeBase
(Consumer<GetKnowledgeBaseRequest.Builder> getKnowledgeBaseRequest) Gets information about a knoweldge base.default GetKnowledgeBaseResponse
getKnowledgeBase
(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Gets information about a knoweldge base.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 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 ListIngestionJobsResponse
listIngestionJobs
(Consumer<ListIngestionJobsRequest.Builder> listIngestionJobsRequest) Lists the ingestion jobs for a data source and information about each of them.default ListIngestionJobsResponse
listIngestionJobs
(ListIngestionJobsRequest listIngestionJobsRequest) Lists the ingestion jobs for a data source and information about each of them.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.default ListKnowledgeBasesResponse
listKnowledgeBases
(Consumer<ListKnowledgeBasesRequest.Builder> listKnowledgeBasesRequest) Lists the knowledge bases in an account and information about each of them.default ListKnowledgeBasesResponse
listKnowledgeBases
(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases in an account and information about each of them.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 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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartIngestionJobResponse
startIngestionJob
(Consumer<StartIngestionJobRequest.Builder> startIngestionJobRequest) Begins an ingestion job, in which a data source is added to a knowledge base.default StartIngestionJobResponse
startIngestionJob
(StartIngestionJobRequest startIngestionJobRequest) Begins an ingestion job, in which a data source is added to a knowledge base.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 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 configurations for a data source.default UpdateDataSourceResponse
updateDataSource
(UpdateDataSourceRequest updateDataSourceRequest) Updates configurations for a data source.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.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
-
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 override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts. -
If you agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for you to troubleshoot.
- 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 override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts. -
If you agent fails to be created, the response returns a list of
failureReasons
alongside a list ofrecommendedActions
for you to troubleshoot.
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
. You must leave thedescription
,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
. You must leave thedescription
,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 Sets up a data source to be added to a knowledge base.
You can't change the
chunkingConfiguration
after you create the data source.- Parameters:
createDataSourceRequest
-- Returns:
- 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 Sets up a data source to be added to a knowledge base.
You can't change the
chunkingConfiguration
after you create the data source.
This is a convenience which creates an instance of the
CreateDataSourceRequest.Builder
avoiding the need to create one manually 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:
-
createKnowledgeBase
default CreateKnowledgeBaseResponse createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
-
Provide the
name
and an 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 that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
-
Provide the
name
and an 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:
-
-
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:
-
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:
-
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:
-
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:
-
getIngestionJob
default GetIngestionJobResponse getIngestionJob(GetIngestionJobRequest getIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Gets information about a ingestion job, in which a data source is added to a knowledge base.
- 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 ingestion job, in which a data source is added to a knowledge base.
This is a convenience which creates an instance of the
GetIngestionJobRequest.Builder
avoiding the need to create one manually 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:
-
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:
-
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:
-
listIngestionJobs
default ListIngestionJobsResponse listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, AwsServiceException, SdkClientException, BedrockAgentException Lists the ingestion jobs for a data source and information about each of them.
- 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 ingestion jobs for a data source and information about each of them.
This is a convenience which creates an instance of the
ListIngestionJobsRequest.Builder
avoiding the need to create one manually 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:
-
listKnowledgeBases
default ListKnowledgeBasesResponse listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, AwsServiceException, SdkClientException, BedrockAgentException Lists the knowledge bases in an account and information about each of them.
- 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 and information about each of them.
This is a convenience which creates an instance of the
ListKnowledgeBasesRequest.Builder
avoiding the need to create one manually 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:
-
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:
-
startIngestionJob
default StartIngestionJobResponse startIngestionJob(StartIngestionJobRequest startIngestionJobRequest) throws ThrottlingException, AccessDeniedException, ValidationException, InternalServerException, ResourceNotFoundException, ConflictException, ServiceQuotaExceededException, AwsServiceException, SdkClientException, BedrockAgentException Begins an ingestion job, in which a data source is added to a knowledge base.
- 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 an ingestion job, in which a data source is added to a knowledge base.
This is a convenience which creates an instance of the
StartIngestionJobRequest.Builder
avoiding the need to create one manually 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:
-
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:
-
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 configurations for a data source.
You can't change the
chunkingConfiguration
after you create the data source. 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 configurations for a data source.
You can't change the
chunkingConfiguration
after you create the data source. 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:
-
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:
-
-
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
-