AbstractAWSBedrockAgent (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagent.AbstractAWSBedrockAgent

All Implemented Interfaces:

AWSBedrockAgent

Direct Known Subclasses:

AbstractAWSBedrockAgentAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSBedrockAgent
extends Object
implements AWSBedrockAgent
```
Abstract implementation of AWSBedrockAgent. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateAgentKnowledgeBaseResult`	`associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)` Associates a knowledge base with an agent.
`CreateAgentResult`	`createAgent(CreateAgentRequest request)` Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
`CreateAgentActionGroupResult`	`createAgentActionGroup(CreateAgentActionGroupRequest request)` Creates an action group for an agent.
`CreateAgentAliasResult`	`createAgentAlias(CreateAgentAliasRequest request)` Creates an alias of an agent that can be used to deploy the agent.
`CreateDataSourceResult`	`createDataSource(CreateDataSourceRequest request)` Creates a data source connector for a knowledge base.
`CreateFlowResult`	`createFlow(CreateFlowRequest request)` Creates a prompt flow that you can use to send an input through various steps to yield an output.
`CreateFlowAliasResult`	`createFlowAlias(CreateFlowAliasRequest request)` Creates an alias of a flow for deployment.
`CreateFlowVersionResult`	`createFlowVersion(CreateFlowVersionRequest request)` Creates a version of the flow that you can deploy.
`CreateKnowledgeBaseResult`	`createKnowledgeBase(CreateKnowledgeBaseRequest request)` Creates a knowledge base that contains data sources from which information can be queried and used by LLMs.
`CreatePromptResult`	`createPrompt(CreatePromptRequest request)` Creates a prompt in your prompt library that you can add to a flow.
`CreatePromptVersionResult`	`createPromptVersion(CreatePromptVersionRequest request)` Creates a static snapshot of your prompt that can be deployed to production.
`DeleteAgentResult`	`deleteAgent(DeleteAgentRequest request)` Deletes an agent.
`DeleteAgentActionGroupResult`	`deleteAgentActionGroup(DeleteAgentActionGroupRequest request)` Deletes an action group in an agent.
`DeleteAgentAliasResult`	`deleteAgentAlias(DeleteAgentAliasRequest request)` Deletes an alias of an agent.
`DeleteAgentVersionResult`	`deleteAgentVersion(DeleteAgentVersionRequest request)` Deletes a version of an agent.
`DeleteDataSourceResult`	`deleteDataSource(DeleteDataSourceRequest request)` Deletes a data source from a knowledge base.
`DeleteFlowResult`	`deleteFlow(DeleteFlowRequest request)` Deletes a flow.
`DeleteFlowAliasResult`	`deleteFlowAlias(DeleteFlowAliasRequest request)` Deletes an alias of a flow.
`DeleteFlowVersionResult`	`deleteFlowVersion(DeleteFlowVersionRequest request)` Deletes a version of a flow.
`DeleteKnowledgeBaseResult`	`deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)` Deletes a knowledge base.
`DeletePromptResult`	`deletePrompt(DeletePromptRequest request)` Deletes a prompt or a prompt version from the Prompt management tool.
`DisassociateAgentKnowledgeBaseResult`	`disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)` Disassociates a knowledge base from an agent.
`GetAgentResult`	`getAgent(GetAgentRequest request)` Gets information about an agent.
`GetAgentActionGroupResult`	`getAgentActionGroup(GetAgentActionGroupRequest request)` Gets information about an action group for an agent.
`GetAgentAliasResult`	`getAgentAlias(GetAgentAliasRequest request)` Gets information about an alias of an agent.
`GetAgentKnowledgeBaseResult`	`getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)` Gets information about a knowledge base associated with an agent.
`GetAgentVersionResult`	`getAgentVersion(GetAgentVersionRequest request)` Gets details about a version of an agent.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetDataSourceResult`	`getDataSource(GetDataSourceRequest request)` Gets information about a data source.
`GetFlowResult`	`getFlow(GetFlowRequest request)` Retrieves information about a flow.
`GetFlowAliasResult`	`getFlowAlias(GetFlowAliasRequest request)` Retrieves information about a flow.
`GetFlowVersionResult`	`getFlowVersion(GetFlowVersionRequest request)` Retrieves information about a version of a flow.
`GetIngestionJobResult`	`getIngestionJob(GetIngestionJobRequest request)` Gets information about a ingestion job, in which a data source is added to a knowledge base.
`GetKnowledgeBaseResult`	`getKnowledgeBase(GetKnowledgeBaseRequest request)` Gets information about a knoweldge base.
`GetPromptResult`	`getPrompt(GetPromptRequest request)` Retrieves information about a prompt or a version of it.
`ListAgentActionGroupsResult`	`listAgentActionGroups(ListAgentActionGroupsRequest request)` Lists the action groups for an agent and information about each one.
`ListAgentAliasesResult`	`listAgentAliases(ListAgentAliasesRequest request)` Lists the aliases of an agent and information about each one.
`ListAgentKnowledgeBasesResult`	`listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)` Lists knowledge bases associated with an agent and information about each one.
`ListAgentsResult`	`listAgents(ListAgentsRequest request)` Lists the agents belonging to an account and information about each agent.
`ListAgentVersionsResult`	`listAgentVersions(ListAgentVersionsRequest request)` Lists the versions of an agent and information about each version.
`ListDataSourcesResult`	`listDataSources(ListDataSourcesRequest request)` Lists the data sources in a knowledge base and information about each one.
`ListFlowAliasesResult`	`listFlowAliases(ListFlowAliasesRequest request)` Returns a list of aliases for a flow.
`ListFlowsResult`	`listFlows(ListFlowsRequest request)` Returns a list of flows and information about each flow.
`ListFlowVersionsResult`	`listFlowVersions(ListFlowVersionsRequest request)` Returns a list of information about each flow.
`ListIngestionJobsResult`	`listIngestionJobs(ListIngestionJobsRequest request)` Lists the ingestion jobs for a data source and information about each of them.
`ListKnowledgeBasesResult`	`listKnowledgeBases(ListKnowledgeBasesRequest request)` Lists the knowledge bases in an account and information about each of them.
`ListPromptsResult`	`listPrompts(ListPromptsRequest request)` Returns a list of prompts from the Prompt management tool and information about each prompt.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` List all the tags for the resource you specify.
`PrepareAgentResult`	`prepareAgent(PrepareAgentRequest request)` Creates a `DRAFT` version of the agent that can be used for internal testing.
`PrepareFlowResult`	`prepareFlow(PrepareFlowRequest request)` Prepares the `DRAFT` version of a flow so that it can be invoked.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartIngestionJobResult`	`startIngestionJob(StartIngestionJobRequest request)` Begins an ingestion job, in which a data source is added to a knowledge base.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associate tags with a resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Remove tags from a resource.
`UpdateAgentResult`	`updateAgent(UpdateAgentRequest request)` Updates the configuration of an agent.
`UpdateAgentActionGroupResult`	`updateAgentActionGroup(UpdateAgentActionGroupRequest request)` Updates the configuration for an action group for an agent.
`UpdateAgentAliasResult`	`updateAgentAlias(UpdateAgentAliasRequest request)` Updates configurations for an alias of an agent.
`UpdateAgentKnowledgeBaseResult`	`updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)` Updates the configuration for a knowledge base that has been associated with an agent.
`UpdateDataSourceResult`	`updateDataSource(UpdateDataSourceRequest request)` Updates the configurations for a data source connector.
`UpdateFlowResult`	`updateFlow(UpdateFlowRequest request)` Modifies a flow.
`UpdateFlowAliasResult`	`updateFlowAlias(UpdateFlowAliasRequest request)` Modifies the alias of a flow.
`UpdateKnowledgeBaseResult`	`updateKnowledgeBase(UpdateKnowledgeBaseRequest request)` Updates the configuration of a knowledge base with the fields that you specify.
`UpdatePromptResult`	`updatePrompt(UpdatePromptRequest request)` Modifies a prompt in your prompt library.

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

- Method Detail
  - associateAgentKnowledgeBase
```
public AssociateAgentKnowledgeBaseResult associateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.
    
    Specified by:
    
    associateAgentKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the AssociateAgentKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgent
```
public CreateAgentResult createAgent(CreateAgentRequest request)
```
    Description copied from interface: AWSBedrockAgent
    Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.
    - Specify the following fields for security purposes.
      
      agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.
      
      (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.
      
      (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.
    - To enable your agent to retain conversational context across multiple sessions, include a memoryConfiguration object. For more information, see Configure memory.
    - To override the default prompt behavior for agent orchestration and to use advanced prompts, include a promptOverrideConfiguration object. For more information, see Advanced prompts.
    - If you agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.
    Specified by:
    
    createAgent in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgentActionGroup
```
public CreateAgentActionGroupResult createAgentActionGroup(CreateAgentActionGroupRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.
    
    To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.
    
    To allow your agent to generate, run, and troubleshoot code when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.CodeInterpreter.
    
    You must leave the description, apiSchema, and actionGroupExecutor fields blank for this action group. During orchestration, if your agent determines that it needs to invoke an API in an action group, but doesn't have enough information to complete the API request, it will invoke this action group instead and return an Observation reprompting the user for more information.
    
    Specified by:
    
    createAgentActionGroup in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateAgentActionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAgentAlias
```
public CreateAgentAliasResult createAgentAlias(CreateAgentAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates an alias of an agent that can be used to deploy the agent.
    
    Specified by:
    
    createAgentAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateAgentAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDataSource
```
public CreateDataSourceResult createDataSource(CreateDataSourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates a data source connector for a knowledge base.
    
    You can't change the chunkingConfiguration after you create the data source connector.
    
    Specified by:
    
    createDataSource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFlow
```
public CreateFlowResult createFlow(CreateFlowRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates a prompt flow that you can use to send an input through various steps to yield an output. Configure nodes, each of which corresponds to a step of the flow, and create connections between the nodes to create paths to different outputs. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    createFlow in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateFlow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFlowAlias
```
public CreateFlowAliasResult createFlowAlias(CreateFlowAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    createFlowAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateFlowAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createFlowVersion
```
public CreateFlowVersionResult createFlowVersion(CreateFlowVersionRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates a version of the flow that you can deploy. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    createFlowVersion in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateFlowVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKnowledgeBase
```
public CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    Creates a knowledge base that contains data sources from which information can be queried and used by LLMs. To create a knowledge base, you must first set up your data sources and configure a supported vector store. For more information, see Set up your data for ingestion.
    
    If you prefer to let Amazon Bedrock create and manage a vector store for you in Amazon OpenSearch Service, use the console. For more information, see Create a knowledge base.
    - Provide the name and an optional description.
    - Provide the Amazon Resource Name (ARN) with permissions to create a knowledge base in the roleArn field.
    - Provide the embedding model to use in the embeddingModelArn field in the knowledgeBaseConfiguration object.
    - Provide the configuration for your vector store in the storageConfiguration object.
      
      For an Amazon OpenSearch Service database, use the opensearchServerlessConfiguration object. For more information, see Create a vector store in Amazon OpenSearch Service.
      
      For an Amazon Aurora database, use the RdsConfiguration object. For more information, see Create a vector store in Amazon Aurora.
      
      For a Pinecone database, use the pineconeConfiguration object. For more information, see Create a vector store in Pinecone.
      
      For a Redis Enterprise Cloud database, use the redisEnterpriseCloudConfiguration object. For more information, see Create a vector store in Redis Enterprise Cloud.
    Specified by:
    
    createKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreateKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPrompt
```
public CreatePromptResult createPrompt(CreatePromptRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates a prompt in your prompt library that you can add to a flow. For more information, see Prompt management in Amazon Bedrock, Create a prompt using Prompt management and Prompt flows in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    createPrompt in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreatePrompt operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPromptVersion
```
public CreatePromptVersionResult createPromptVersion(CreatePromptVersionRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates a static snapshot of your prompt that can be deployed to production. For more information, see Deploy prompts using Prompt management by creating versions in the Amazon Bedrock User Guide.
    
    Specified by:
    
    createPromptVersion in interface AWSBedrockAgent
    
    Returns:
    
    Result of the CreatePromptVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgent
```
public DeleteAgentResult deleteAgent(DeleteAgentRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes an agent.
    
    Specified by:
    
    deleteAgent in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgentActionGroup
```
public DeleteAgentActionGroupResult deleteAgentActionGroup(DeleteAgentActionGroupRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes an action group in an agent.
    
    Specified by:
    
    deleteAgentActionGroup in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteAgentActionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgentAlias
```
public DeleteAgentAliasResult deleteAgentAlias(DeleteAgentAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes an alias of an agent.
    
    Specified by:
    
    deleteAgentAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteAgentAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAgentVersion
```
public DeleteAgentVersionResult deleteAgentVersion(DeleteAgentVersionRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes a version of an agent.
    
    Specified by:
    
    deleteAgentVersion in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteAgentVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDataSource
```
public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes a data source from a knowledge base.
    
    Specified by:
    
    deleteDataSource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFlow
```
public DeleteFlowResult deleteFlow(DeleteFlowRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes a flow.
    
    Specified by:
    
    deleteFlow in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteFlow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFlowAlias
```
public DeleteFlowAliasResult deleteFlowAlias(DeleteFlowAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes an alias of a flow.
    
    Specified by:
    
    deleteFlowAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteFlowAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteFlowVersion
```
public DeleteFlowVersionResult deleteFlowVersion(DeleteFlowVersionRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes a version of a flow.
    
    Specified by:
    
    deleteFlowVersion in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteFlowVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKnowledgeBase
```
public DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.
    
    Specified by:
    
    deleteKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeleteKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePrompt
```
public DeletePromptResult deletePrompt(DeletePromptRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Deletes a prompt or a prompt version from the Prompt management tool. For more information, see Delete prompts from the Prompt management tool and Delete a version of a prompt from the Prompt management tool in the Amazon Bedrock User Guide.
    
    Specified by:
    
    deletePrompt in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DeletePrompt operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateAgentKnowledgeBase
```
public DisassociateAgentKnowledgeBaseResult disassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Disassociates a knowledge base from an agent.
    
    Specified by:
    
    disassociateAgentKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the DisassociateAgentKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAgent
```
public GetAgentResult getAgent(GetAgentRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about an agent.
    
    Specified by:
    
    getAgent in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAgentActionGroup
```
public GetAgentActionGroupResult getAgentActionGroup(GetAgentActionGroupRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about an action group for an agent.
    
    Specified by:
    
    getAgentActionGroup in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetAgentActionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAgentAlias
```
public GetAgentAliasResult getAgentAlias(GetAgentAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about an alias of an agent.
    
    Specified by:
    
    getAgentAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetAgentAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAgentKnowledgeBase
```
public GetAgentKnowledgeBaseResult getAgentKnowledgeBase(GetAgentKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about a knowledge base associated with an agent.
    
    Specified by:
    
    getAgentKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetAgentKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAgentVersion
```
public GetAgentVersionResult getAgentVersion(GetAgentVersionRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets details about a version of an agent.
    
    Specified by:
    
    getAgentVersion in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetAgentVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getDataSource
```
public GetDataSourceResult getDataSource(GetDataSourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about a data source.
    
    Specified by:
    
    getDataSource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getFlow
```
public GetFlowResult getFlow(GetFlowRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    getFlow in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetFlow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getFlowAlias
```
public GetFlowAliasResult getFlowAlias(GetFlowAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    getFlowAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetFlowAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getFlowVersion
```
public GetFlowVersionResult getFlowVersion(GetFlowVersionRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    getFlowVersion in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetFlowVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getIngestionJob
```
public GetIngestionJobResult getIngestionJob(GetIngestionJobRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about a ingestion job, in which a data source is added to a knowledge base.
    
    Specified by:
    
    getIngestionJob in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetIngestionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKnowledgeBase
```
public GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Gets information about a knoweldge base.
    
    Specified by:
    
    getKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getPrompt
```
public GetPromptResult getPrompt(GetPromptRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Retrieves information about a prompt or a version of it. For more information, see View information about prompts using Prompt management and View information about a version of your prompt in the Amazon Bedrock User Guide.
    
    Specified by:
    
    getPrompt in interface AWSBedrockAgent
    
    Returns:
    
    Result of the GetPrompt operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgentActionGroups
```
public ListAgentActionGroupsResult listAgentActionGroups(ListAgentActionGroupsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the action groups for an agent and information about each one.
    
    Specified by:
    
    listAgentActionGroups in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListAgentActionGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgentAliases
```
public ListAgentAliasesResult listAgentAliases(ListAgentAliasesRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the aliases of an agent and information about each one.
    
    Specified by:
    
    listAgentAliases in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListAgentAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgentKnowledgeBases
```
public ListAgentKnowledgeBasesResult listAgentKnowledgeBases(ListAgentKnowledgeBasesRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists knowledge bases associated with an agent and information about each one.
    
    Specified by:
    
    listAgentKnowledgeBases in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListAgentKnowledgeBases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgentVersions
```
public ListAgentVersionsResult listAgentVersions(ListAgentVersionsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the versions of an agent and information about each version.
    
    Specified by:
    
    listAgentVersions in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListAgentVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAgents
```
public ListAgentsResult listAgents(ListAgentsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the agents belonging to an account and information about each agent.
    
    Specified by:
    
    listAgents in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListAgents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDataSources
```
public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the data sources in a knowledge base and information about each one.
    
    Specified by:
    
    listDataSources in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListDataSources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFlowAliases
```
public ListFlowAliasesResult listFlowAliases(ListFlowAliasesRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Returns a list of aliases for a flow.
    
    Specified by:
    
    listFlowAliases in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListFlowAliases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFlowVersions
```
public ListFlowVersionsResult listFlowVersions(ListFlowVersionsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    listFlowVersions in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListFlowVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listFlows
```
public ListFlowsResult listFlows(ListFlowsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Returns a list of flows and information about each flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    listFlows in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListFlows operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listIngestionJobs
```
public ListIngestionJobsResult listIngestionJobs(ListIngestionJobsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the ingestion jobs for a data source and information about each of them.
    
    Specified by:
    
    listIngestionJobs in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListIngestionJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKnowledgeBases
```
public ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Lists the knowledge bases in an account and information about each of them.
    
    Specified by:
    
    listKnowledgeBases in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListKnowledgeBases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPrompts
```
public ListPromptsResult listPrompts(ListPromptsRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Returns a list of prompts from the Prompt management tool and information about each prompt. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.
    
    Specified by:
    
    listPrompts in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListPrompts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    List all the tags for the resource you specify.
    
    Specified by:
    
    listTagsForResource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - prepareAgent
```
public PrepareAgentResult prepareAgent(PrepareAgentRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Creates a DRAFT version of the agent that can be used for internal testing.
    
    Specified by:
    
    prepareAgent in interface AWSBedrockAgent
    
    Returns:
    
    Result of the PrepareAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - prepareFlow
```
public PrepareFlowResult prepareFlow(PrepareFlowRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Prepares the DRAFT version of a flow so that it can be invoked. For more information, see Test a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    prepareFlow in interface AWSBedrockAgent
    
    Returns:
    
    Result of the PrepareFlow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startIngestionJob
```
public StartIngestionJobResult startIngestionJob(StartIngestionJobRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Begins an ingestion job, in which a data source is added to a knowledge base.
    
    Specified by:
    
    startIngestionJob in interface AWSBedrockAgent
    
    Returns:
    
    Result of the StartIngestionJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.
    
    Specified by:
    
    tagResource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Remove tags from a resource.
    
    Specified by:
    
    untagResource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgent
```
public UpdateAgentResult updateAgent(UpdateAgentRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Updates the configuration of an agent.
    
    Specified by:
    
    updateAgent in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateAgent operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgentActionGroup
```
public UpdateAgentActionGroupResult updateAgentActionGroup(UpdateAgentActionGroupRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Updates the configuration for an action group for an agent.
    
    Specified by:
    
    updateAgentActionGroup in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateAgentActionGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgentAlias
```
public UpdateAgentAliasResult updateAgentAlias(UpdateAgentAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Updates configurations for an alias of an agent.
    
    Specified by:
    
    updateAgentAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateAgentAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAgentKnowledgeBase
```
public UpdateAgentKnowledgeBaseResult updateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Updates the configuration for a knowledge base that has been associated with an agent.
    
    Specified by:
    
    updateAgentKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateAgentKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDataSource
```
public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Updates the configurations for a data source connector.
    
    You can't change the chunkingConfiguration after you create the data source connector. Specify the existing chunkingConfiguration.
    
    Specified by:
    
    updateDataSource in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateDataSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFlow
```
public UpdateFlowResult updateFlow(UpdateFlowRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Modifies a flow. Include both fields that you want to keep and fields that you want to change. For more information, see How it works and Create a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    updateFlow in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateFlow operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateFlowAlias
```
public UpdateFlowAliasResult updateFlowAlias(UpdateFlowAliasRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Modifies the alias of a flow. Include both fields that you want to keep and ones that you want to change. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    Specified by:
    
    updateFlowAlias in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateFlowAlias operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKnowledgeBase
```
public UpdateKnowledgeBaseResult updateKnowledgeBase(UpdateKnowledgeBaseRequest request)
```
    Description copied from interface: AWSBedrockAgent
    Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
    
    You can change the following fields:
    - name
    - description
    - roleArn
    You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.
    Specified by:
    
    updateKnowledgeBase in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdateKnowledgeBase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePrompt
```
public UpdatePromptResult updatePrompt(UpdatePromptRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    Modifies a prompt in your prompt library. Include both fields that you want to keep and fields that you want to replace. For more information, see Prompt management in Amazon Bedrock and Edit prompts in your prompt library in the Amazon Bedrock User Guide.
    
    Specified by:
    
    updatePrompt in interface AWSBedrockAgent
    
    Returns:
    
    Result of the UpdatePrompt operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSBedrockAgent
    
    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.
    
    Specified by:
    
    shutdown in interface AWSBedrockAgent
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSBedrockAgent
    
    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.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.792

Class AbstractAWSBedrockAgent

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateAgentKnowledgeBase

createAgent

createAgentActionGroup

createAgentAlias

createDataSource

createFlow

createFlowAlias

createFlowVersion

createKnowledgeBase

createPrompt

createPromptVersion

deleteAgent

deleteAgentActionGroup

deleteAgentAlias

deleteAgentVersion

deleteDataSource

deleteFlow

deleteFlowAlias

deleteFlowVersion

deleteKnowledgeBase

deletePrompt

disassociateAgentKnowledgeBase

getAgent

getAgentActionGroup

getAgentAlias

getAgentKnowledgeBase

getAgentVersion

getDataSource

getFlow

getFlowAlias

getFlowVersion

getIngestionJob

getKnowledgeBase

getPrompt

listAgentActionGroups

listAgentAliases

listAgentKnowledgeBases

listAgentVersions

listAgents

listDataSources

listFlowAliases

listFlowVersions

listFlows

listIngestionJobs

listKnowledgeBases

listPrompts

listTagsForResource

prepareAgent

prepareFlow

startIngestionJob

tagResource

untagResource

updateAgent

updateAgentActionGroup

updateAgentAlias

updateAgentKnowledgeBase

updateDataSource

updateFlow

updateFlowAlias

updateKnowledgeBase

updatePrompt

shutdown

getCachedResponseMetadata