AWSBedrockAgentClient (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.bedrockagent.AWSBedrockAgentClient

All Implemented Interfaces:

AWSBedrockAgent

Direct Known Subclasses:

AWSBedrockAgentAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBedrockAgentClient
extends AmazonWebServiceClient
implements AWSBedrockAgent
```
Client for accessing Agents for Amazon Bedrock. All service calls made using this client are blocking, and will not return until the service call completes.

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

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  LOGGING_AWS_REQUEST_METRIC
- Fields inherited from interface com.amazonaws.services.bedrockagent.AWSBedrockAgent
  ENDPOINT_PREFIX

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateAgentKnowledgeBaseResult`	`associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)` Associate a Knowledge Base to an existing Amazon Bedrock Agent
`static AWSBedrockAgentClientBuilder`	`builder()`
`CreateAgentResult`	`createAgent(CreateAgentRequest request)` Creates an Amazon Bedrock Agent
`CreateAgentActionGroupResult`	`createAgentActionGroup(CreateAgentActionGroupRequest request)` Creates an Action Group for existing Amazon Bedrock Agent
`CreateAgentAliasResult`	`createAgentAlias(CreateAgentAliasRequest request)` Creates an Alias for an existing Amazon Bedrock Agent
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest request)` Create a new data source
`CreateKnowledgeBaseResult`	`createKnowledgeBase(CreateKnowledgeBaseRequest request)` Create a new knowledge base
`DeleteAgentResult`	`deleteAgent(DeleteAgentRequest request)` Deletes an Agent for existing Amazon Bedrock Agent
`DeleteAgentActionGroupResult`	`deleteAgentActionGroup(DeleteAgentActionGroupRequest request)` Deletes an Action Group for existing Amazon Bedrock Agent.
`DeleteAgentAliasResult`	`deleteAgentAlias(DeleteAgentAliasRequest request)` Deletes an Alias for a Amazon Bedrock Agent
`DeleteAgentVersionResult`	`deleteAgentVersion(DeleteAgentVersionRequest request)` Deletes an Agent version for existing Amazon Bedrock Agent
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest request)` Delete an existing data source
`DeleteKnowledgeBaseResult`	`deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)` Delete an existing knowledge base
`DisassociateAgentKnowledgeBaseResult`	`disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)` Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
`GetAgentResult`	`getAgent(GetAgentRequest request)` Gets an Agent for existing Amazon Bedrock Agent
`GetAgentActionGroupResult`	`getAgentActionGroup(GetAgentActionGroupRequest request)` Gets an Action Group for existing Amazon Bedrock Agent Version
`GetAgentAliasResult`	`getAgentAlias(GetAgentAliasRequest request)` Describes an Alias for a Amazon Bedrock Agent
`GetAgentKnowledgeBaseResult`	`getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)` Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
`GetAgentVersionResult`	`getAgentVersion(GetAgentVersionRequest request)` 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 request)` Get an existing data source
`GetIngestionJobResult`	`getIngestionJob(GetIngestionJobRequest request)` Get an ingestion job
`GetKnowledgeBaseResult`	`getKnowledgeBase(GetKnowledgeBaseRequest request)` Get an existing knowledge base
`ListAgentActionGroupsResult`	`listAgentActionGroups(ListAgentActionGroupsRequest request)` Lists an Action Group for existing Amazon Bedrock Agent Version
`ListAgentAliasesResult`	`listAgentAliases(ListAgentAliasesRequest request)` Lists all the Aliases for an Amazon Bedrock Agent
`ListAgentKnowledgeBasesResult`	`listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)` List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
`ListAgentsResult`	`listAgents(ListAgentsRequest request)` Lists Agents
`ListAgentVersionsResult`	`listAgentVersions(ListAgentVersionsRequest request)` Lists Agent Versions
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest request)` List data sources
`ListIngestionJobsResult`	`listIngestionJobs(ListIngestionJobsRequest request)` List ingestion jobs
`ListKnowledgeBasesResult`	`listKnowledgeBases(ListKnowledgeBasesRequest request)` List Knowledge Bases
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List tags for a resource
`PrepareAgentResult`	`prepareAgent(PrepareAgentRequest request)` 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 request)` Start a new ingestion job
`TagResourceResult`	`tagResource(TagResourceRequest request)` Tag a resource
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Untag a resource
`UpdateAgentResult`	`updateAgent(UpdateAgentRequest request)` Updates an existing Amazon Bedrock Agent
`UpdateAgentActionGroupResult`	`updateAgentActionGroup(UpdateAgentActionGroupRequest request)` Updates an existing Action Group for Amazon Bedrock Agent
`UpdateAgentAliasResult`	`updateAgentAlias(UpdateAgentAliasRequest request)` Updates an existing Alias for an Amazon Bedrock Agent
`UpdateAgentKnowledgeBaseResult`	`updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)` Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Update an existing data source
`UpdateKnowledgeBaseResult`	`updateKnowledgeBase(UpdateKnowledgeBaseRequest request)` Update an existing knowledge base

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - builder
```
public static AWSBedrockAgentClientBuilder builder()
```
  - associateAgentKnowledgeBase
```
public AssociateAgentKnowledgeBaseResult associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)
```
    Associate a Knowledge Base to an existing Amazon Bedrock Agent
    
    Specified by:
    
    associateAgentKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public CreateAgentResult createAgent(CreateAgentRequest request)
```
    Creates an Amazon Bedrock Agent
    
    Specified by:
    
    createAgent in interface AWSBedrockAgent
    
    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
```
public CreateAgentActionGroupResult createAgentActionGroup(CreateAgentActionGroupRequest request)
```
    Creates an Action Group for existing Amazon Bedrock Agent
    
    Specified by:
    
    createAgentActionGroup in interface AWSBedrockAgent
    
    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
```
public CreateAgentAliasResult createAgentAlias(CreateAgentAliasRequest request)
```
    Creates an Alias for an existing Amazon Bedrock Agent
    
    Specified by:
    
    createAgentAlias in interface AWSBedrockAgent
    
    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
```
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
```
    Create a new data source
    
    Specified by:
    
    createDataSource in interface AWSBedrockAgent
    
    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
```
public CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)
```
    Create a new knowledge base
    
    Specified by:
    
    createKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
```
    Deletes an Agent for existing Amazon Bedrock Agent
    
    Specified by:
    
    deleteAgent in interface AWSBedrockAgent
    
    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
```
public DeleteAgentActionGroupResult deleteAgentActionGroup(DeleteAgentActionGroupRequest request)
```
    Deletes an Action Group for existing Amazon Bedrock Agent.
    
    Specified by:
    
    deleteAgentActionGroup in interface AWSBedrockAgent
    
    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
```
public DeleteAgentAliasResult deleteAgentAlias(DeleteAgentAliasRequest request)
```
    Deletes an Alias for a Amazon Bedrock Agent
    
    Specified by:
    
    deleteAgentAlias in interface AWSBedrockAgent
    
    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
```
public DeleteAgentVersionResult deleteAgentVersion(DeleteAgentVersionRequest request)
```
    Deletes an Agent version for existing Amazon Bedrock Agent
    
    Specified by:
    
    deleteAgentVersion in interface AWSBedrockAgent
    
    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
```
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
```
    Delete an existing data source
    
    Specified by:
    
    deleteDataSource in interface AWSBedrockAgent
    
    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
```
public DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
```
    Delete an existing knowledge base
    
    Specified by:
    
    deleteKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public DisassociateAgentKnowledgeBaseResult disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)
```
    Disassociate an existing Knowledge Base from an Amazon Bedrock Agent
    
    Specified by:
    
    disassociateAgentKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public GetAgentResult getAgent(GetAgentRequest request)
```
    Gets an Agent for existing Amazon Bedrock Agent
    
    Specified by:
    
    getAgent in interface AWSBedrockAgent
    
    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
```
public GetAgentActionGroupResult getAgentActionGroup(GetAgentActionGroupRequest request)
```
    Gets an Action Group for existing Amazon Bedrock Agent Version
    
    Specified by:
    
    getAgentActionGroup in interface AWSBedrockAgent
    
    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
```
public GetAgentAliasResult getAgentAlias(GetAgentAliasRequest request)
```
    Describes an Alias for a Amazon Bedrock Agent
    
    Specified by:
    
    getAgentAlias in interface AWSBedrockAgent
    
    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
```
public GetAgentKnowledgeBaseResult getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)
```
    Gets a knowledge base associated to an existing Amazon Bedrock Agent Version
    
    Specified by:
    
    getAgentKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public GetAgentVersionResult getAgentVersion(GetAgentVersionRequest request)
```
    Gets an Agent version for existing Amazon Bedrock Agent
    
    Specified by:
    
    getAgentVersion in interface AWSBedrockAgent
    
    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
```
public GetDataSourceResult getDataSource(GetDataSourceRequest request)
```
    Get an existing data source
    
    Specified by:
    
    getDataSource in interface AWSBedrockAgent
    
    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
```
public GetIngestionJobResult getIngestionJob(GetIngestionJobRequest request)
```
    Get an ingestion job
    
    Specified by:
    
    getIngestionJob in interface AWSBedrockAgent
    
    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
```
public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
```
    Get an existing knowledge base
    
    Specified by:
    
    getKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public ListAgentActionGroupsResult listAgentActionGroups(ListAgentActionGroupsRequest request)
```
    Lists an Action Group for existing Amazon Bedrock Agent Version
    
    Specified by:
    
    listAgentActionGroups in interface AWSBedrockAgent
    
    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
```
public ListAgentAliasesResult listAgentAliases(ListAgentAliasesRequest request)
```
    Lists all the Aliases for an Amazon Bedrock Agent
    
    Specified by:
    
    listAgentAliases in interface AWSBedrockAgent
    
    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
```
public ListAgentKnowledgeBasesResult listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)
```
    List of Knowledge Bases associated to an existing Amazon Bedrock Agent Version
    
    Specified by:
    
    listAgentKnowledgeBases in interface AWSBedrockAgent
    
    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
```
public ListAgentVersionsResult listAgentVersions(ListAgentVersionsRequest request)
```
    Lists Agent Versions
    
    Specified by:
    
    listAgentVersions in interface AWSBedrockAgent
    
    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
```
public ListAgentsResult listAgents(ListAgentsRequest request)
```
    Lists Agents
    
    Specified by:
    
    listAgents in interface AWSBedrockAgent
    
    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
```
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
```
    List data sources
    
    Specified by:
    
    listDataSources in interface AWSBedrockAgent
    
    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
```
public ListIngestionJobsResult listIngestionJobs(ListIngestionJobsRequest request)
```
    List ingestion jobs
    
    Specified by:
    
    listIngestionJobs in interface AWSBedrockAgent
    
    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
```
public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
```
    List Knowledge Bases
    
    Specified by:
    
    listKnowledgeBases in interface AWSBedrockAgent
    
    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
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    List tags for a resource
    
    Specified by:
    
    listTagsForResource in interface AWSBedrockAgent
    
    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
```
public PrepareAgentResult prepareAgent(PrepareAgentRequest request)
```
    Prepares an existing Amazon Bedrock Agent to receive runtime requests
    
    Specified by:
    
    prepareAgent in interface AWSBedrockAgent
    
    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
```
public StartIngestionJobResult startIngestionJob(StartIngestionJobRequest request)
```
    Start a new ingestion job
    
    Specified by:
    
    startIngestionJob in interface AWSBedrockAgent
    
    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
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Tag a resource
    
    Specified by:
    
    tagResource in interface AWSBedrockAgent
    
    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
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Untag a resource
    
    Specified by:
    
    untagResource in interface AWSBedrockAgent
    
    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
```
public UpdateAgentResult updateAgent(UpdateAgentRequest request)
```
    Updates an existing Amazon Bedrock Agent
    
    Specified by:
    
    updateAgent in interface AWSBedrockAgent
    
    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
```
public UpdateAgentActionGroupResult updateAgentActionGroup(UpdateAgentActionGroupRequest request)
```
    Updates an existing Action Group for Amazon Bedrock Agent
    
    Specified by:
    
    updateAgentActionGroup in interface AWSBedrockAgent
    
    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
```
public UpdateAgentAliasResult updateAgentAlias(UpdateAgentAliasRequest request)
```
    Updates an existing Alias for an Amazon Bedrock Agent
    
    Specified by:
    
    updateAgentAlias in interface AWSBedrockAgent
    
    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
```
public UpdateAgentKnowledgeBaseResult updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)
```
    Updates an existing Knowledge Base associated to an Amazon Bedrock Agent
    
    Specified by:
    
    updateAgentKnowledgeBase in interface AWSBedrockAgent
    
    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
```
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
```
    Update an existing data source
    
    Specified by:
    
    updateDataSource in interface AWSBedrockAgent
    
    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
```
public UpdateKnowledgeBaseResult updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
```
    Update an existing knowledge base
    
    Specified by:
    
    updateKnowledgeBase in interface AWSBedrockAgent
    
    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
  - getCachedResponseMetadata
```
public 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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSBedrockAgent
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - shutdown
```
public void shutdown()
```
    Description copied from class: AmazonWebServiceClient
    
    Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSBedrockAgent
    
    Overrides:
    
    shutdown in class AmazonWebServiceClient

AWS SDK for Java 1.x API Reference - 1.12.679

Class AWSBedrockAgentClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.bedrockagent.AWSBedrockAgent

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Method Detail

builder

associateAgentKnowledgeBase

createAgent

createAgentActionGroup

createAgentAlias

createDataSource

createKnowledgeBase

deleteAgent

deleteAgentActionGroup

deleteAgentAlias

deleteAgentVersion

deleteDataSource

deleteKnowledgeBase

disassociateAgentKnowledgeBase

getAgent

getAgentActionGroup

getAgentAlias

getAgentKnowledgeBase

getAgentVersion

getDataSource

getIngestionJob

getKnowledgeBase

listAgentActionGroups

listAgentAliases

listAgentKnowledgeBases

listAgentVersions

listAgents

listDataSources

listIngestionJobs

listKnowledgeBases

listTagsForResource

prepareAgent

startIngestionJob

tagResource

untagResource

updateAgent

updateAgentActionGroup

updateAgentAlias

updateAgentKnowledgeBase

updateDataSource

updateKnowledgeBase

getCachedResponseMetadata

shutdown