@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSBedrockAgentClient extends AmazonWebServiceClient implements AWSBedrockAgent
Describes the API operations for creating and managing Amazon Bedrock agents.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssociateAgentKnowledgeBaseResult |
associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)
Associates a knowledge base with an agent.
|
static AWSBedrockAgentClientBuilder |
builder() |
CreateAgentResult |
createAgent(CreateAgentRequest request)
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 request)
Creates an action group for an agent.
|
CreateAgentAliasResult |
createAgentAlias(CreateAgentAliasRequest request)
Creates an alias of an agent that can be used to deploy the agent.
|
CreateDataSourceResult |
createDataSource(CreateDataSourceRequest request)
Sets up a data source to be added to a knowledge base.
|
CreateKnowledgeBaseResult |
createKnowledgeBase(CreateKnowledgeBaseRequest request)
Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
|
DeleteAgentResult |
deleteAgent(DeleteAgentRequest request)
Deletes an agent.
|
DeleteAgentActionGroupResult |
deleteAgentActionGroup(DeleteAgentActionGroupRequest request)
Deletes an action group in an agent.
|
DeleteAgentAliasResult |
deleteAgentAlias(DeleteAgentAliasRequest request)
Deletes an alias of an agent.
|
DeleteAgentVersionResult |
deleteAgentVersion(DeleteAgentVersionRequest request)
Deletes a version of an agent.
|
DeleteDataSourceResult |
deleteDataSource(DeleteDataSourceRequest request)
Deletes a data source from a knowledge base.
|
DeleteKnowledgeBaseResult |
deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
Deletes a knowledge base.
|
DisassociateAgentKnowledgeBaseResult |
disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)
Disassociates a knowledge base from an agent.
|
GetAgentResult |
getAgent(GetAgentRequest request)
Gets information about an agent.
|
GetAgentActionGroupResult |
getAgentActionGroup(GetAgentActionGroupRequest request)
Gets information about an action group for an agent.
|
GetAgentAliasResult |
getAgentAlias(GetAgentAliasRequest request)
Gets information about an alias of an agent.
|
GetAgentKnowledgeBaseResult |
getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)
Gets information about a knowledge base associated with an agent.
|
GetAgentVersionResult |
getAgentVersion(GetAgentVersionRequest request)
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 request)
Gets information about a data source.
|
GetIngestionJobResult |
getIngestionJob(GetIngestionJobRequest request)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
|
GetKnowledgeBaseResult |
getKnowledgeBase(GetKnowledgeBaseRequest request)
Gets information about a knoweldge base.
|
ListAgentActionGroupsResult |
listAgentActionGroups(ListAgentActionGroupsRequest request)
Lists the action groups for an agent and information about each one.
|
ListAgentAliasesResult |
listAgentAliases(ListAgentAliasesRequest request)
Lists the aliases of an agent and information about each one.
|
ListAgentKnowledgeBasesResult |
listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)
Lists knowledge bases associated with an agent and information about each one.
|
ListAgentsResult |
listAgents(ListAgentsRequest request)
Lists the agents belonging to an account and information about each agent.
|
ListAgentVersionsResult |
listAgentVersions(ListAgentVersionsRequest request)
Lists the versions of an agent and information about each version.
|
ListDataSourcesResult |
listDataSources(ListDataSourcesRequest request)
Lists the data sources in a knowledge base and information about each one.
|
ListIngestionJobsResult |
listIngestionJobs(ListIngestionJobsRequest request)
Lists the ingestion jobs for a data source and information about each of them.
|
ListKnowledgeBasesResult |
listKnowledgeBases(ListKnowledgeBasesRequest request)
Lists the knowledge bases in an account and information about each of them.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List all the tags for the resource you specify.
|
PrepareAgentResult |
prepareAgent(PrepareAgentRequest request)
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 request)
Begins an ingestion job, in which a data source is added to a knowledge base.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associate tags with a resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Remove tags from a resource.
|
UpdateAgentResult |
updateAgent(UpdateAgentRequest request)
Updates the configuration of an agent.
|
UpdateAgentActionGroupResult |
updateAgentActionGroup(UpdateAgentActionGroupRequest request)
Updates the configuration for an action group for an agent.
|
UpdateAgentAliasResult |
updateAgentAlias(UpdateAgentAliasRequest request)
Updates configurations for an alias of an agent.
|
UpdateAgentKnowledgeBaseResult |
updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)
Updates the configuration for a knowledge base that has been associated with an agent.
|
UpdateDataSourceResult |
updateDataSource(UpdateDataSourceRequest request)
Updates configurations for a data source.
|
UpdateKnowledgeBaseResult |
updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
Updates the configuration of a knowledge base with the fields that you specify.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSBedrockAgentClientBuilder builder()
public AssociateAgentKnowledgeBaseResult associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)
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.
associateAgentKnowledgeBase
in interface AWSBedrockAgent
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.public CreateAgentResult createAgent(CreateAgentRequest request)
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.
createAgent
in interface AWSBedrockAgent
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.public CreateAgentActionGroupResult createAgentActionGroup(CreateAgentActionGroupRequest request)
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.
createAgentActionGroup
in interface AWSBedrockAgent
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.public CreateAgentAliasResult createAgentAlias(CreateAgentAliasRequest request)
Creates an alias of an agent that can be used to deploy the agent.
createAgentAlias
in interface AWSBedrockAgent
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.public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
Sets up a data source to be added to a knowledge base.
You can't change the chunkingConfiguration
after you create the data source.
createDataSource
in interface AWSBedrockAgent
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.public CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)
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.
createKnowledgeBase
in interface AWSBedrockAgent
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.public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
Deletes an agent.
deleteAgent
in interface AWSBedrockAgent
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.public DeleteAgentActionGroupResult deleteAgentActionGroup(DeleteAgentActionGroupRequest request)
Deletes an action group in an agent.
deleteAgentActionGroup
in interface AWSBedrockAgent
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.public DeleteAgentAliasResult deleteAgentAlias(DeleteAgentAliasRequest request)
Deletes an alias of an agent.
deleteAgentAlias
in interface AWSBedrockAgent
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.public DeleteAgentVersionResult deleteAgentVersion(DeleteAgentVersionRequest request)
Deletes a version of an agent.
deleteAgentVersion
in interface AWSBedrockAgent
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.public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
Deletes a data source from a knowledge base.
deleteDataSource
in interface AWSBedrockAgent
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.public DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
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.
deleteKnowledgeBase
in interface AWSBedrockAgent
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.public DisassociateAgentKnowledgeBaseResult disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)
Disassociates a knowledge base from an agent.
disassociateAgentKnowledgeBase
in interface AWSBedrockAgent
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.public GetAgentResult getAgent(GetAgentRequest request)
Gets information about an agent.
getAgent
in interface AWSBedrockAgent
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.public GetAgentActionGroupResult getAgentActionGroup(GetAgentActionGroupRequest request)
Gets information about an action group for an agent.
getAgentActionGroup
in interface AWSBedrockAgent
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.public GetAgentAliasResult getAgentAlias(GetAgentAliasRequest request)
Gets information about an alias of an agent.
getAgentAlias
in interface AWSBedrockAgent
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.public GetAgentKnowledgeBaseResult getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)
Gets information about a knowledge base associated with an agent.
getAgentKnowledgeBase
in interface AWSBedrockAgent
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.public GetAgentVersionResult getAgentVersion(GetAgentVersionRequest request)
Gets details about a version of an agent.
getAgentVersion
in interface AWSBedrockAgent
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.public GetDataSourceResult getDataSource(GetDataSourceRequest request)
Gets information about a data source.
getDataSource
in interface AWSBedrockAgent
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.public GetIngestionJobResult getIngestionJob(GetIngestionJobRequest request)
Gets information about a ingestion job, in which a data source is added to a knowledge base.
getIngestionJob
in interface AWSBedrockAgent
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.public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
Gets information about a knoweldge base.
getKnowledgeBase
in interface AWSBedrockAgent
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.public ListAgentActionGroupsResult listAgentActionGroups(ListAgentActionGroupsRequest request)
Lists the action groups for an agent and information about each one.
listAgentActionGroups
in interface AWSBedrockAgent
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.public ListAgentAliasesResult listAgentAliases(ListAgentAliasesRequest request)
Lists the aliases of an agent and information about each one.
listAgentAliases
in interface AWSBedrockAgent
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.public ListAgentKnowledgeBasesResult listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)
Lists knowledge bases associated with an agent and information about each one.
listAgentKnowledgeBases
in interface AWSBedrockAgent
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.public ListAgentVersionsResult listAgentVersions(ListAgentVersionsRequest request)
Lists the versions of an agent and information about each version.
listAgentVersions
in interface AWSBedrockAgent
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.public ListAgentsResult listAgents(ListAgentsRequest request)
Lists the agents belonging to an account and information about each agent.
listAgents
in interface AWSBedrockAgent
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.public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
Lists the data sources in a knowledge base and information about each one.
listDataSources
in interface AWSBedrockAgent
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.public ListIngestionJobsResult listIngestionJobs(ListIngestionJobsRequest request)
Lists the ingestion jobs for a data source and information about each of them.
listIngestionJobs
in interface AWSBedrockAgent
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.public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
Lists the knowledge bases in an account and information about each of them.
listKnowledgeBases
in interface AWSBedrockAgent
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.public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List all the tags for the resource you specify.
listTagsForResource
in interface AWSBedrockAgent
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.public PrepareAgentResult prepareAgent(PrepareAgentRequest request)
Creates a DRAFT
version of the agent that can be used for internal testing.
prepareAgent
in interface AWSBedrockAgent
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.public StartIngestionJobResult startIngestionJob(StartIngestionJobRequest request)
Begins an ingestion job, in which a data source is added to a knowledge base.
startIngestionJob
in interface AWSBedrockAgent
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.public TagResourceResult tagResource(TagResourceRequest request)
Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
tagResource
in interface AWSBedrockAgent
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.public UntagResourceResult untagResource(UntagResourceRequest request)
Remove tags from a resource.
untagResource
in interface AWSBedrockAgent
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.public UpdateAgentResult updateAgent(UpdateAgentRequest request)
Updates the configuration of an agent.
updateAgent
in interface AWSBedrockAgent
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.public UpdateAgentActionGroupResult updateAgentActionGroup(UpdateAgentActionGroupRequest request)
Updates the configuration for an action group for an agent.
updateAgentActionGroup
in interface AWSBedrockAgent
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.public UpdateAgentAliasResult updateAgentAlias(UpdateAgentAliasRequest request)
Updates configurations for an alias of an agent.
updateAgentAlias
in interface AWSBedrockAgent
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.public UpdateAgentKnowledgeBaseResult updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)
Updates the configuration for a knowledge base that has been associated with an agent.
updateAgentKnowledgeBase
in interface AWSBedrockAgent
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.public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
Updates configurations for a data source.
You can't change the chunkingConfiguration
after you create the data source. Specify the existing
chunkingConfiguration
.
updateDataSource
in interface AWSBedrockAgent
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.public UpdateKnowledgeBaseResult updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
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.
updateKnowledgeBase
in interface AWSBedrockAgent
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.public 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 the request.
getCachedResponseMetadata
in interface AWSBedrockAgent
request
- The originally executed requestpublic void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSBedrockAgent
shutdown
in class AmazonWebServiceClient