@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSBedrockAgent
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSBedrockAgent
instead.
Describes the API operations for creating and managing Amazon Bedrock agents.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
AssociateAgentKnowledgeBaseResult |
associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)
Associates a knowledge base with an agent.
|
CreateAgentResult |
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.
|
CreateAgentActionGroupResult |
createAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest)
Creates an action group for an agent.
|
CreateAgentAliasResult |
createAgentAlias(CreateAgentAliasRequest createAgentAliasRequest)
Creates an alias of an agent that can be used to deploy the agent.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest createDataSourceRequest)
Sets up a data source to be added to a knowledge base.
|
CreateKnowledgeBaseResult |
createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
|
DeleteAgentActionGroupResult |
deleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest)
Deletes an action group in an agent.
|
DeleteAgentAliasResult |
deleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest)
Deletes an alias of an agent.
|
DeleteAgentVersionResult |
deleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest)
Deletes a version of an agent.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes a data source from a knowledge base.
|
DeleteKnowledgeBaseResult |
deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)
Deletes a knowledge base.
|
DisassociateAgentKnowledgeBaseResult |
disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest)
Disassociates a knowledge base from an agent.
|
GetAgentResult |
getAgent(GetAgentRequest getAgentRequest)
Gets information about an agent.
|
GetAgentActionGroupResult |
getAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest)
Gets information about an action group for an agent.
|
GetAgentAliasResult |
getAgentAlias(GetAgentAliasRequest getAgentAliasRequest)
Gets information about an alias of an agent.
|
GetAgentKnowledgeBaseResult |
getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest)
Gets information about a knowledge base associated with an agent.
|
GetAgentVersionResult |
getAgentVersion(GetAgentVersionRequest getAgentVersionRequest)
Gets details about a version of an agent.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetDataSourceResult |
getDataSource(GetDataSourceRequest getDataSourceRequest)
Gets information about a data source.
|
GetIngestionJobResult |
getIngestionJob(GetIngestionJobRequest getIngestionJobRequest)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
|
GetKnowledgeBaseResult |
getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)
Gets information about a knoweldge base.
|
ListAgentActionGroupsResult |
listAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest)
Lists the action groups for an agent and information about each one.
|
ListAgentAliasesResult |
listAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest)
Lists the aliases of an agent and information about each one.
|
ListAgentKnowledgeBasesResult |
listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)
Lists knowledge bases associated with an agent and information about each one.
|
ListAgentsResult |
listAgents(ListAgentsRequest listAgentsRequest)
Lists the agents belonging to an account and information about each agent.
|
ListAgentVersionsResult |
listAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest)
Lists the versions of an agent and information about each version.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources in a knowledge base and information about each one.
|
ListIngestionJobsResult |
listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest)
Lists the ingestion jobs for a data source and information about each of them.
|
ListKnowledgeBasesResult |
listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)
Lists the knowledge bases in an account and information about each of them.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all the tags for the resource you specify.
|
PrepareAgentResult |
prepareAgent(PrepareAgentRequest prepareAgentRequest)
Creates a
DRAFT version of the agent that can be used for internal testing. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartIngestionJobResult |
startIngestionJob(StartIngestionJobRequest startIngestionJobRequest)
Begins an ingestion job, in which a data source is added to a knowledge base.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associate tags with a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the configuration of an agent.
|
UpdateAgentActionGroupResult |
updateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest)
Updates the configuration for an action group for an agent.
|
UpdateAgentAliasResult |
updateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest)
Updates configurations for an alias of an agent.
|
UpdateAgentKnowledgeBaseResult |
updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest)
Updates the configuration for a knowledge base that has been associated with an agent.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates configurations for a data source.
|
UpdateKnowledgeBaseResult |
updateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest)
Updates the configuration of a knowledge base with the fields that you specify.
|
static final String ENDPOINT_PREFIX
AssociateAgentKnowledgeBaseResult associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)
Associates a knowledge base with an agent. If a knowledge base is associated and its indexState
is
set to Enabled
, the agent queries the knowledge base for information to augment its response to the
user.
associateAgentKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.CreateAgentResult createAgent(CreateAgentRequest createAgentRequest)
Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
Specify the following fields for security purposes.
agentResourceRoleArn
– The Amazon Resource Name (ARN) of the role with permissions to invoke API
operations on an agent.
(Optional) customerEncryptionKeyArn
– The Amazon Resource Name (ARN) of a KMS key to encrypt the
creation of the agent.
(Optional) idleSessionTTLinSeconds
– Specify the number of seconds for which the agent should
maintain session information. After this time expires, the subsequent InvokeAgent
request begins a
new session.
To override the default prompt behavior for agent orchestration and to use advanced prompts, include a
promptOverrideConfiguration
object. For more information, see Advanced prompts.
If you agent fails to be created, the response returns a list of failureReasons
alongside a list of
recommendedActions
for you to troubleshoot.
createAgentRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.CreateAgentActionGroupResult createAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest)
Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
To allow your agent to request the user for additional information when trying to complete a task, add an action
group with the parentActionGroupSignature
field set to AMAZON.UserInput
. You must leave
the description
, apiSchema
, and actionGroupExecutor
fields blank for this
action group. During orchestration, if your agent determines that it needs to invoke an API in an action group,
but doesn't have enough information to complete the API request, it will invoke this action group instead and
return an Observation
reprompting the user for more information.
createAgentActionGroupRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.CreateAgentAliasResult createAgentAlias(CreateAgentAliasRequest createAgentAliasRequest)
Creates an alias of an agent that can be used to deploy the agent.
createAgentAliasRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
createDataSourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
Provide the name
and an optional description
.
Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn
field.
Provide the embedding model to use in the embeddingModelArn
field in the
knowledgeBaseConfiguration
object.
Provide the configuration for your vector store in the storageConfiguration
object.
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.
createKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.DeleteAgentResult deleteAgent(DeleteAgentRequest deleteAgentRequest)
Deletes an agent.
deleteAgentRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.DeleteAgentActionGroupResult deleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest)
Deletes an action group in an agent.
deleteAgentActionGroupRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.DeleteAgentAliasResult deleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest)
Deletes an alias of an agent.
deleteAgentAliasRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.DeleteAgentVersionResult deleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest)
Deletes a version of an agent.
deleteAgentVersionRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)
Deletes a data source from a knowledge base.
deleteDataSourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)
Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
deleteKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.DisassociateAgentKnowledgeBaseResult disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest)
Disassociates a knowledge base from an agent.
disassociateAgentKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.GetAgentResult getAgent(GetAgentRequest getAgentRequest)
Gets information about an agent.
getAgentRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetAgentActionGroupResult getAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest)
Gets information about an action group for an agent.
getAgentActionGroupRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetAgentAliasResult getAgentAlias(GetAgentAliasRequest getAgentAliasRequest)
Gets information about an alias of an agent.
getAgentAliasRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetAgentKnowledgeBaseResult getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest)
Gets information about a knowledge base associated with an agent.
getAgentKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetAgentVersionResult getAgentVersion(GetAgentVersionRequest getAgentVersionRequest)
Gets details about a version of an agent.
getAgentVersionRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)
Gets information about a data source.
getDataSourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetIngestionJobResult getIngestionJob(GetIngestionJobRequest getIngestionJobRequest)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
getIngestionJobRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)
Gets information about a knoweldge base.
getKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListAgentActionGroupsResult listAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest)
Lists the action groups for an agent and information about each one.
listAgentActionGroupsRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListAgentAliasesResult listAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest)
Lists the aliases of an agent and information about each one.
listAgentAliasesRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListAgentKnowledgeBasesResult listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)
Lists knowledge bases associated with an agent and information about each one.
listAgentKnowledgeBasesRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListAgentVersionsResult listAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest)
Lists the versions of an agent and information about each version.
listAgentVersionsRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListAgentsResult listAgents(ListAgentsRequest listAgentsRequest)
Lists the agents belonging to an account and information about each agent.
listAgentsRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)
Lists the data sources in a knowledge base and information about each one.
listDataSourcesRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListIngestionJobsResult listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest)
Lists the ingestion jobs for a data source and information about each of them.
listIngestionJobsRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)
Lists the knowledge bases in an account and information about each of them.
listKnowledgeBasesRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List all the tags for the resource you specify.
listTagsForResourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.PrepareAgentResult prepareAgent(PrepareAgentRequest prepareAgentRequest)
Creates a DRAFT
version of the agent that can be used for internal testing.
prepareAgentRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.StartIngestionJobResult startIngestionJob(StartIngestionJobRequest startIngestionJobRequest)
Begins an ingestion job, in which a data source is added to a knowledge base.
startIngestionJobRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
tagResourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Remove tags from a resource.
untagResourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest)
Updates the configuration of an agent.
updateAgentRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.UpdateAgentActionGroupResult updateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest)
Updates the configuration for an action group for an agent.
updateAgentActionGroupRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.UpdateAgentAliasResult updateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest)
Updates configurations for an alias of an agent.
updateAgentAliasRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.ServiceQuotaExceededException
- The number of requests exceeds the service quota. Resubmit your request later.UpdateAgentKnowledgeBaseResult updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest)
Updates the configuration for a knowledge base that has been associated with an agent.
updateAgentKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)
Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing
chunkingConfiguration
.
updateDataSourceRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.UpdateKnowledgeBaseResult updateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest)
Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
name
description
roleArn
You can't change the knowledgeBaseConfiguration
or storageConfiguration
fields, so you
must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
updateKnowledgeBaseRequest
- ThrottlingException
- The number of requests exceeds the limit. Resubmit your request later.AccessDeniedException
- The request is denied because of missing access permissions.ValidationException
- Input validation failed. Check your request parameters and retry the request.InternalServerException
- An internal server error occurred. Retry your request.ResourceNotFoundException
- The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and
try your request again.ConflictException
- There was a conflict performing an operation.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.