com.amazonaws.services.bedrockagent

Interface AWSBedrockAgent

All Known Subinterfaces:

AWSBedrockAgentAsync

All Known Implementing Classes:

AbstractAWSBedrockAgent, AbstractAWSBedrockAgentAsync, AWSBedrockAgentAsyncClient, AWSBedrockAgentClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSBedrockAgent

Interface for accessing Agents for Amazon Bedrock.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSBedrockAgent instead.

An example service, deployed with the Octane Service creator, which will echo the string

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AssociateAgentKnowledgeBaseResult	associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest) Associate a Knowledge Base to an existing Amazon Bedrock Agent
CreateAgentResult	createAgent(CreateAgentRequest createAgentRequest) Creates an Amazon Bedrock Agent
CreateAgentActionGroupResult	createAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest) Creates an Action Group for existing Amazon Bedrock Agent
CreateAgentAliasResult	createAgentAlias(CreateAgentAliasRequest createAgentAliasRequest) Creates an Alias for an existing Amazon Bedrock Agent
CreateDataSourceResult	createDataSource(CreateDataSourceRequest createDataSourceRequest) Create a new data source
CreateKnowledgeBaseResult	createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Create a new knowledge base
DeleteAgentResult	deleteAgent(DeleteAgentRequest deleteAgentRequest) Deletes an Agent for existing Amazon Bedrock Agent
DeleteAgentActionGroupResult	deleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest) Deletes an Action Group for existing Amazon Bedrock Agent.
DeleteAgentAliasResult	deleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest) Deletes an Alias for a Amazon Bedrock Agent
DeleteAgentVersionResult	deleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest) Deletes an Agent version for existing Amazon Bedrock Agent
DeleteDataSourceResult	deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Delete an existing data source
DeleteKnowledgeBaseResult	deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Delete an existing knowledge base
DisassociateAgentKnowledgeBaseResult	disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest) Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
GetAgentResult	getAgent(GetAgentRequest getAgentRequest) Gets an Agent for existing Amazon Bedrock Agent
GetAgentActionGroupResult	getAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest) Gets an Action Group for existing Amazon Bedrock Agent Version
GetAgentAliasResult	getAgentAlias(GetAgentAliasRequest getAgentAliasRequest) Describes an Alias for a Amazon Bedrock Agent
GetAgentKnowledgeBaseResult	getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest) Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
GetAgentVersionResult	getAgentVersion(GetAgentVersionRequest getAgentVersionRequest) Gets an Agent version for existing Amazon Bedrock 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) Get an existing data source
GetIngestionJobResult	getIngestionJob(GetIngestionJobRequest getIngestionJobRequest) Get an ingestion job
GetKnowledgeBaseResult	getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Get an existing knowledge base
ListAgentActionGroupsResult	listAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest) Lists an Action Group for existing Amazon Bedrock Agent Version
ListAgentAliasesResult	listAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest) Lists all the Aliases for an Amazon Bedrock Agent
ListAgentKnowledgeBasesResult	listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest) List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
ListAgentsResult	listAgents(ListAgentsRequest listAgentsRequest) Lists Agents
ListAgentVersionsResult	listAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest) Lists Agent Versions
ListDataSourcesResult	listDataSources(ListDataSourcesRequest listDataSourcesRequest) List data sources
ListIngestionJobsResult	listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest) List ingestion jobs
ListKnowledgeBasesResult	listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) List Knowledge Bases
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List tags for a resource
PrepareAgentResult	prepareAgent(PrepareAgentRequest prepareAgentRequest) Prepares an existing Amazon Bedrock Agent to receive runtime requests
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartIngestionJobResult	startIngestionJob(StartIngestionJobRequest startIngestionJobRequest) Start a new ingestion job
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Tag a resource
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Untag a resource
UpdateAgentResult	updateAgent(UpdateAgentRequest updateAgentRequest) Updates an existing Amazon Bedrock Agent
UpdateAgentActionGroupResult	updateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest) Updates an existing Action Group for Amazon Bedrock Agent
UpdateAgentAliasResult	updateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest) Updates an existing Alias for an Amazon Bedrock Agent
UpdateAgentKnowledgeBaseResult	updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest) Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
UpdateDataSourceResult	updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Update an existing data source
UpdateKnowledgeBaseResult	updateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest) Update an existing knowledge base

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

associateAgentKnowledgeBase

AssociateAgentKnowledgeBaseResult associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest associateAgentKnowledgeBaseRequest)

Associate a Knowledge Base to an existing Amazon Bedrock Agent

Parameters:

associateAgentKnowledgeBaseRequest - Associate Agent Knowledge Base Request

Returns:

Result of the AssociateAgentKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

createAgent

CreateAgentResult createAgent(CreateAgentRequest createAgentRequest)

Creates an Amazon Bedrock Agent

Parameters:

createAgentRequest - Create Agent Request

Returns:

Result of the CreateAgent operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

createAgentActionGroup

CreateAgentActionGroupResult createAgentActionGroup(CreateAgentActionGroupRequest createAgentActionGroupRequest)

Creates an Action Group for existing Amazon Bedrock Agent

Parameters:

createAgentActionGroupRequest - Create Action Group Request

Returns:

Result of the CreateAgentActionGroup operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

createAgentAlias

CreateAgentAliasResult createAgentAlias(CreateAgentAliasRequest createAgentAliasRequest)

Creates an Alias for an existing Amazon Bedrock Agent

Parameters:

createAgentAliasRequest - Create Agent Alias Request

Returns:

Result of the CreateAgentAlias operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

createDataSource

CreateDataSourceResult createDataSource(CreateDataSourceRequest createDataSourceRequest)

Create a new data source

Parameters:

createDataSourceRequest -

Returns:

Result of the CreateDataSource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

createKnowledgeBase

CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)

Create a new knowledge base

Parameters:

createKnowledgeBaseRequest -

Returns:

Result of the CreateKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

deleteAgent

DeleteAgentResult deleteAgent(DeleteAgentRequest deleteAgentRequest)

Deletes an Agent for existing Amazon Bedrock Agent

Parameters:

deleteAgentRequest - Delete Agent Request

Returns:

Result of the DeleteAgent operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

deleteAgentActionGroup

DeleteAgentActionGroupResult deleteAgentActionGroup(DeleteAgentActionGroupRequest deleteAgentActionGroupRequest)

Deletes an Action Group for existing Amazon Bedrock Agent.

Parameters:

deleteAgentActionGroupRequest - Delete Action Group Request

Returns:

Result of the DeleteAgentActionGroup operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

deleteAgentAlias

DeleteAgentAliasResult deleteAgentAlias(DeleteAgentAliasRequest deleteAgentAliasRequest)

Deletes an Alias for a Amazon Bedrock Agent

Parameters:

deleteAgentAliasRequest - Delete Agent Alias Request

Returns:

Result of the DeleteAgentAlias operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

deleteAgentVersion

DeleteAgentVersionResult deleteAgentVersion(DeleteAgentVersionRequest deleteAgentVersionRequest)

Deletes an Agent version for existing Amazon Bedrock Agent

Parameters:

deleteAgentVersionRequest - Delete Agent Version Request

Returns:

Result of the DeleteAgentVersion operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

deleteDataSource

DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest)

Delete an existing data source

Parameters:

deleteDataSourceRequest -

Returns:

Result of the DeleteDataSource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

deleteKnowledgeBase

DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)

Delete an existing knowledge base

Parameters:

deleteKnowledgeBaseRequest -

Returns:

Result of the DeleteKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

disassociateAgentKnowledgeBase

DisassociateAgentKnowledgeBaseResult disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest disassociateAgentKnowledgeBaseRequest)

Disassociate an existing Knowledge Base from an Amazon Bedrock Agent

Parameters:

disassociateAgentKnowledgeBaseRequest - Disassociate Agent Knowledge Base Request

Returns:

Result of the DisassociateAgentKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

getAgent

GetAgentResult getAgent(GetAgentRequest getAgentRequest)

Gets an Agent for existing Amazon Bedrock Agent

Parameters:

getAgentRequest - Get Agent Request

Returns:

Result of the GetAgent operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getAgentActionGroup

GetAgentActionGroupResult getAgentActionGroup(GetAgentActionGroupRequest getAgentActionGroupRequest)

Gets an Action Group for existing Amazon Bedrock Agent Version

Parameters:

getAgentActionGroupRequest - Get Action Group Request

Returns:

Result of the GetAgentActionGroup operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getAgentAlias

GetAgentAliasResult getAgentAlias(GetAgentAliasRequest getAgentAliasRequest)

Describes an Alias for a Amazon Bedrock Agent

Parameters:

getAgentAliasRequest - Get Agent Alias Request

Returns:

Result of the GetAgentAlias operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getAgentKnowledgeBase

GetAgentKnowledgeBaseResult getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest getAgentKnowledgeBaseRequest)

Gets a knowledge base associated to an existing Amazon Bedrock Agent Version

Parameters:

getAgentKnowledgeBaseRequest - Get Agent Knowledge Base Request

Returns:

Result of the GetAgentKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getAgentVersion

GetAgentVersionResult getAgentVersion(GetAgentVersionRequest getAgentVersionRequest)

Gets an Agent version for existing Amazon Bedrock Agent

Parameters:

getAgentVersionRequest - Get Agent Version Request

Returns:

Result of the GetAgentVersion operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getDataSource

GetDataSourceResult getDataSource(GetDataSourceRequest getDataSourceRequest)

Get an existing data source

Parameters:

getDataSourceRequest -

Returns:

Result of the GetDataSource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getIngestionJob

GetIngestionJobResult getIngestionJob(GetIngestionJobRequest getIngestionJobRequest)

Get an ingestion job

Parameters:

getIngestionJobRequest -

Returns:

Result of the GetIngestionJob operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

getKnowledgeBase

GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)

Get an existing knowledge base

Parameters:

getKnowledgeBaseRequest -

Returns:

Result of the GetKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listAgentActionGroups

ListAgentActionGroupsResult listAgentActionGroups(ListAgentActionGroupsRequest listAgentActionGroupsRequest)

Lists an Action Group for existing Amazon Bedrock Agent Version

Parameters:

listAgentActionGroupsRequest - List Action Groups Request

Returns:

Result of the ListAgentActionGroups operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listAgentAliases

ListAgentAliasesResult listAgentAliases(ListAgentAliasesRequest listAgentAliasesRequest)

Lists all the Aliases for an Amazon Bedrock Agent

Parameters:

listAgentAliasesRequest - List Agent Aliases Request

Returns:

Result of the ListAgentAliases operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listAgentKnowledgeBases

ListAgentKnowledgeBasesResult listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest listAgentKnowledgeBasesRequest)

List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version

Parameters:

listAgentKnowledgeBasesRequest - List Agent Knowledge Bases Request

Returns:

Result of the ListAgentKnowledgeBases operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listAgentVersions

ListAgentVersionsResult listAgentVersions(ListAgentVersionsRequest listAgentVersionsRequest)

Lists Agent Versions

Parameters:

listAgentVersionsRequest - List Agent Versions Request

Returns:

Result of the ListAgentVersions operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listAgents

ListAgentsResult listAgents(ListAgentsRequest listAgentsRequest)

Lists Agents

Parameters:

listAgentsRequest - List Agent Request

Returns:

Result of the ListAgents operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

See Also:

AWS API Documentation

listDataSources

ListDataSourcesResult listDataSources(ListDataSourcesRequest listDataSourcesRequest)

List data sources

Parameters:

listDataSourcesRequest -

Returns:

Result of the ListDataSources operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listIngestionJobs

ListIngestionJobsResult listIngestionJobs(ListIngestionJobsRequest listIngestionJobsRequest)

List ingestion jobs

Parameters:

listIngestionJobsRequest -

Returns:

Result of the ListIngestionJobs operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

listKnowledgeBases

ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)

List Knowledge Bases

Parameters:

listKnowledgeBasesRequest -

Returns:

Result of the ListKnowledgeBases operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List tags for a resource

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

prepareAgent

PrepareAgentResult prepareAgent(PrepareAgentRequest prepareAgentRequest)

Prepares an existing Amazon Bedrock Agent to receive runtime requests

Parameters:

prepareAgentRequest - PrepareAgent Request

Returns:

Result of the PrepareAgent operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

startIngestionJob

StartIngestionJobResult startIngestionJob(StartIngestionJobRequest startIngestionJobRequest)

Start a new ingestion job

Parameters:

startIngestionJobRequest -

Returns:

Result of the StartIngestionJob operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Tag a resource

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Untag a resource

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

See Also:

AWS API Documentation

updateAgent

UpdateAgentResult updateAgent(UpdateAgentRequest updateAgentRequest)

Updates an existing Amazon Bedrock Agent

Parameters:

updateAgentRequest - Update Agent Request

Returns:

Result of the UpdateAgent operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

updateAgentActionGroup

UpdateAgentActionGroupResult updateAgentActionGroup(UpdateAgentActionGroupRequest updateAgentActionGroupRequest)

Updates an existing Action Group for Amazon Bedrock Agent

Parameters:

updateAgentActionGroupRequest - Update Action Group Request

Returns:

Result of the UpdateAgentActionGroup operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

updateAgentAlias

UpdateAgentAliasResult updateAgentAlias(UpdateAgentAliasRequest updateAgentAliasRequest)

Updates an existing Alias for an Amazon Bedrock Agent

Parameters:

updateAgentAliasRequest - Update Agent Alias Request

Returns:

Result of the UpdateAgentAlias operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

ServiceQuotaExceededException - This exception is thrown when a request is made beyond the service quota

See Also:

AWS API Documentation

updateAgentKnowledgeBase

UpdateAgentKnowledgeBaseResult updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest updateAgentKnowledgeBaseRequest)

Updates an existing Knowledge Base associated to an Amazon Bedrock Agent

Parameters:

updateAgentKnowledgeBaseRequest - Update Agent Knowledge Base Request

Returns:

Result of the UpdateAgentKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

updateDataSource

UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest updateDataSourceRequest)

Update an existing data source

Parameters:

updateDataSourceRequest -

Returns:

Result of the UpdateDataSource operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

updateKnowledgeBase

UpdateKnowledgeBaseResult updateKnowledgeBase(UpdateKnowledgeBaseRequest updateKnowledgeBaseRequest)

Update an existing knowledge base

Parameters:

updateKnowledgeBaseRequest -

Returns:

Result of the UpdateKnowledgeBase operation returned by the service.

Throws:

ThrottlingException - This exception is thrown when the number of requests exceeds the limit

AccessDeniedException - This exception is thrown when a request is denied per access permissions

ValidationException - This exception is thrown when the request's input validation fails

InternalServerException - This exception is thrown if there was an unexpected error during processing of request

ResourceNotFoundException - This exception is thrown when a resource referenced by the operation does not exist

ConflictException - This exception is thrown when there is a conflict performing an operation

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.