AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Interface for accessing BedrockAgent

Describes the API operations for creating and managing Amazon Bedrock agents.

Inheritance Hierarchy

Amazon.BedrockAgent.IAmazonBedrockAgent

Namespace: Amazon.BedrockAgent
Assembly: AWSSDK.BedrockAgent.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonBedrockAgent
         IAmazonService, IDisposable

The IAmazonBedrockAgent type exposes the following members

Properties

NameTypeDescription
Public Property Paginators Amazon.BedrockAgent.Model.IBedrockAgentPaginatorFactory

Paginators for the service

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method AssociateAgentCollaborator(AssociateAgentCollaboratorRequest)

Makes an agent a collaborator for another agent.

Public Method AssociateAgentCollaboratorAsync(AssociateAgentCollaboratorRequest, CancellationToken)

Makes an agent a collaborator for another agent.

Public Method AssociateAgentKnowledgeBase(AssociateAgentKnowledgeBaseRequest)

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

Public Method AssociateAgentKnowledgeBaseAsync(AssociateAgentKnowledgeBaseRequest, CancellationToken)

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.

Public Method CreateAgent(CreateAgentRequest)

Creates an agent that orchestrates interactions between foundation models, data sources, software applications, user conversations, and APIs to carry out tasks to help customers.

  • Specify the following fields for security purposes.

    • agentResourceRoleArn – The Amazon Resource Name (ARN) of the role with permissions to invoke API operations on an agent.

    • (Optional) customerEncryptionKeyArn – The Amazon Resource Name (ARN) of a KMS key to encrypt the creation of the agent.

    • (Optional) idleSessionTTLinSeconds – Specify the number of seconds for which the agent should maintain session information. After this time expires, the subsequent InvokeAgent request begins a new session.

  • To 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 your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

  • The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.

Public Method CreateAgentActionGroup(CreateAgentActionGroupRequest)

Creates an action group for an agent. An action group represents the actions that an agent can carry out for the customer by defining the APIs that an agent can call and the logic for calling them.

To allow your agent to request the user for additional information when trying to complete a task, add an action group with the parentActionGroupSignature field set to AMAZON.UserInput.

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.

Public Method CreateAgentActionGroupAsync(CreateAgentActionGroupRequest, CancellationToken)

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.

Public Method CreateAgentAlias(CreateAgentAliasRequest)

Creates an alias of an agent that can be used to deploy the agent.

Public Method CreateAgentAliasAsync(CreateAgentAliasRequest, CancellationToken)

Creates an alias of an agent that can be used to deploy the agent.

Public Method CreateAgentAsync(CreateAgentRequest, CancellationToken)

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 your agent fails to be created, the response returns a list of failureReasons alongside a list of recommendedActions for you to troubleshoot.

  • The agent instructions will not be honored if your agent has only one knowledge base, uses default prompts, has no action group, and user input is disabled.

Public Method CreateDataSource(CreateDataSourceRequest)

Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.

You can't change the chunkingConfiguration after you create the data source connector.

Public Method CreateDataSourceAsync(CreateDataSourceRequest, CancellationToken)

Connects a knowledge base to a data source. You specify the configuration for the specific data source service in the dataSourceConfiguration field.

You can't change the chunkingConfiguration after you create the data source connector.

Public Method CreateFlow(CreateFlowRequest)

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.

Public Method CreateFlowAlias(CreateFlowAliasRequest)

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method CreateFlowAliasAsync(CreateFlowAliasRequest, CancellationToken)

Creates an alias of a flow for deployment. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method CreateFlowAsync(CreateFlowRequest, CancellationToken)

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.

Public Method CreateFlowVersion(CreateFlowVersionRequest)

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.

Public Method CreateFlowVersionAsync(CreateFlowVersionRequest, CancellationToken)

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.

Public Method CreateKnowledgeBase(CreateKnowledgeBaseRequest)

Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base.

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.

Public Method CreateKnowledgeBaseAsync(CreateKnowledgeBaseRequest, CancellationToken)

Creates a knowledge base. A knowledge base contains your data sources so that Large Language Models (LLMs) can use your data. 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 a knowledge base.

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.

Public Method CreatePrompt(CreatePromptRequest)

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.

Public Method CreatePromptAsync(CreatePromptRequest, CancellationToken)

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.

Public Method CreatePromptVersion(CreatePromptVersionRequest)

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.

Public Method CreatePromptVersionAsync(CreatePromptVersionRequest, CancellationToken)

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.

Public Method DeleteAgent(DeleteAgentRequest)

Deletes an agent.

Public Method DeleteAgentActionGroup(DeleteAgentActionGroupRequest)

Deletes an action group in an agent.

Public Method DeleteAgentActionGroupAsync(DeleteAgentActionGroupRequest, CancellationToken)

Deletes an action group in an agent.

Public Method DeleteAgentAlias(DeleteAgentAliasRequest)

Deletes an alias of an agent.

Public Method DeleteAgentAliasAsync(DeleteAgentAliasRequest, CancellationToken)

Deletes an alias of an agent.

Public Method DeleteAgentAsync(DeleteAgentRequest, CancellationToken)

Deletes an agent.

Public Method DeleteAgentVersion(DeleteAgentVersionRequest)

Deletes a version of an agent.

Public Method DeleteAgentVersionAsync(DeleteAgentVersionRequest, CancellationToken)

Deletes a version of an agent.

Public Method DeleteDataSource(DeleteDataSourceRequest)

Deletes a data source from a knowledge base.

Public Method DeleteDataSourceAsync(DeleteDataSourceRequest, CancellationToken)

Deletes a data source from a knowledge base.

Public Method DeleteFlow(DeleteFlowRequest)

Deletes a flow.

Public Method DeleteFlowAlias(DeleteFlowAliasRequest)

Deletes an alias of a flow.

Public Method DeleteFlowAliasAsync(DeleteFlowAliasRequest, CancellationToken)

Deletes an alias of a flow.

Public Method DeleteFlowAsync(DeleteFlowRequest, CancellationToken)

Deletes a flow.

Public Method DeleteFlowVersion(DeleteFlowVersionRequest)

Deletes a version of a flow.

Public Method DeleteFlowVersionAsync(DeleteFlowVersionRequest, CancellationToken)

Deletes a version of a flow.

Public Method DeleteKnowledgeBase(DeleteKnowledgeBaseRequest)

Deletes a knowledge base. Before deleting a knowledge base, you should disassociate the knowledge base from any agents that it is associated with by making a DisassociateAgentKnowledgeBase request.

Public Method DeleteKnowledgeBaseAsync(DeleteKnowledgeBaseRequest, CancellationToken)

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.

Public Method DeleteKnowledgeBaseDocuments(DeleteKnowledgeBaseDocumentsRequest)

Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method DeleteKnowledgeBaseDocumentsAsync(DeleteKnowledgeBaseDocumentsRequest, CancellationToken)

Deletes documents from a data source and syncs the changes to the knowledge base that is connected to it. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method DeletePrompt(DeletePromptRequest)

Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. 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.

Public Method DeletePromptAsync(DeletePromptRequest, CancellationToken)

Deletes a prompt or a version of it, depending on whether you include the promptVersion field or not. 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.

Public Method DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Public Method DisassociateAgentCollaborator(DisassociateAgentCollaboratorRequest)

Disassociates an agent collaborator.

Public Method DisassociateAgentCollaboratorAsync(DisassociateAgentCollaboratorRequest, CancellationToken)

Disassociates an agent collaborator.

Public Method DisassociateAgentKnowledgeBase(DisassociateAgentKnowledgeBaseRequest)

Disassociates a knowledge base from an agent.

Public Method DisassociateAgentKnowledgeBaseAsync(DisassociateAgentKnowledgeBaseRequest, CancellationToken)

Disassociates a knowledge base from an agent.

Public Method GetAgent(GetAgentRequest)

Gets information about an agent.

Public Method GetAgentActionGroup(GetAgentActionGroupRequest)

Gets information about an action group for an agent.

Public Method GetAgentActionGroupAsync(GetAgentActionGroupRequest, CancellationToken)

Gets information about an action group for an agent.

Public Method GetAgentAlias(GetAgentAliasRequest)

Gets information about an alias of an agent.

Public Method GetAgentAliasAsync(GetAgentAliasRequest, CancellationToken)

Gets information about an alias of an agent.

Public Method GetAgentAsync(GetAgentRequest, CancellationToken)

Gets information about an agent.

Public Method GetAgentCollaborator(GetAgentCollaboratorRequest)

Retrieves information about an agent's collaborator.

Public Method GetAgentCollaboratorAsync(GetAgentCollaboratorRequest, CancellationToken)

Retrieves information about an agent's collaborator.

Public Method GetAgentKnowledgeBase(GetAgentKnowledgeBaseRequest)

Gets information about a knowledge base associated with an agent.

Public Method GetAgentKnowledgeBaseAsync(GetAgentKnowledgeBaseRequest, CancellationToken)

Gets information about a knowledge base associated with an agent.

Public Method GetAgentVersion(GetAgentVersionRequest)

Gets details about a version of an agent.

Public Method GetAgentVersionAsync(GetAgentVersionRequest, CancellationToken)

Gets details about a version of an agent.

Public Method GetDataSource(GetDataSourceRequest)

Gets information about a data source.

Public Method GetDataSourceAsync(GetDataSourceRequest, CancellationToken)

Gets information about a data source.

Public Method GetFlow(GetFlowRequest)

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method GetFlowAlias(GetFlowAliasRequest)

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method GetFlowAliasAsync(GetFlowAliasRequest, CancellationToken)

Retrieves information about a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method GetFlowAsync(GetFlowRequest, CancellationToken)

Retrieves information about a flow. For more information, see Manage a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method GetFlowVersion(GetFlowVersionRequest)

Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method GetFlowVersionAsync(GetFlowVersionRequest, CancellationToken)

Retrieves information about a version of a flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method GetIngestionJob(GetIngestionJobRequest)

Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Public Method GetIngestionJobAsync(GetIngestionJobRequest, CancellationToken)

Gets information about a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Public Method GetKnowledgeBase(GetKnowledgeBaseRequest)

Gets information about a knoweldge base.

Public Method GetKnowledgeBaseAsync(GetKnowledgeBaseRequest, CancellationToken)

Gets information about a knoweldge base.

Public Method GetKnowledgeBaseDocuments(GetKnowledgeBaseDocumentsRequest)

Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method GetKnowledgeBaseDocumentsAsync(GetKnowledgeBaseDocumentsRequest, CancellationToken)

Retrieves specific documents from a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method GetPrompt(GetPromptRequest)

Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. 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.

Public Method GetPromptAsync(GetPromptRequest, CancellationToken)

Retrieves information about the working draft (DRAFT version) of a prompt or a version of it, depending on whether you include the promptVersion field or not. 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.

Public Method IngestKnowledgeBaseDocuments(IngestKnowledgeBaseDocumentsRequest)

Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method IngestKnowledgeBaseDocumentsAsync(IngestKnowledgeBaseDocumentsRequest, CancellationToken)

Ingests documents directly into the knowledge base that is connected to the data source. The dataSourceType specified in the content for each document must match the type of the data source that you specify in the header. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method ListAgentActionGroups(ListAgentActionGroupsRequest)

Lists the action groups for an agent and information about each one.

Public Method ListAgentActionGroupsAsync(ListAgentActionGroupsRequest, CancellationToken)

Lists the action groups for an agent and information about each one.

Public Method ListAgentAliases(ListAgentAliasesRequest)

Lists the aliases of an agent and information about each one.

Public Method ListAgentAliasesAsync(ListAgentAliasesRequest, CancellationToken)

Lists the aliases of an agent and information about each one.

Public Method ListAgentCollaborators(ListAgentCollaboratorsRequest)

Retrieve a list of an agent's collaborators.

Public Method ListAgentCollaboratorsAsync(ListAgentCollaboratorsRequest, CancellationToken)

Retrieve a list of an agent's collaborators.

Public Method ListAgentKnowledgeBases(ListAgentKnowledgeBasesRequest)

Lists knowledge bases associated with an agent and information about each one.

Public Method ListAgentKnowledgeBasesAsync(ListAgentKnowledgeBasesRequest, CancellationToken)

Lists knowledge bases associated with an agent and information about each one.

Public Method ListAgents(ListAgentsRequest)

Lists the agents belonging to an account and information about each agent.

Public Method ListAgentsAsync(ListAgentsRequest, CancellationToken)

Lists the agents belonging to an account and information about each agent.

Public Method ListAgentVersions(ListAgentVersionsRequest)

Lists the versions of an agent and information about each version.

Public Method ListAgentVersionsAsync(ListAgentVersionsRequest, CancellationToken)

Lists the versions of an agent and information about each version.

Public Method ListDataSources(ListDataSourcesRequest)

Lists the data sources in a knowledge base and information about each one.

Public Method ListDataSourcesAsync(ListDataSourcesRequest, CancellationToken)

Lists the data sources in a knowledge base and information about each one.

Public Method ListFlowAliases(ListFlowAliasesRequest)

Returns a list of aliases for a flow.

Public Method ListFlowAliasesAsync(ListFlowAliasesRequest, CancellationToken)

Returns a list of aliases for a flow.

Public Method ListFlows(ListFlowsRequest)

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.

Public Method ListFlowsAsync(ListFlowsRequest, CancellationToken)

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.

Public Method ListFlowVersions(ListFlowVersionsRequest)

Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method ListFlowVersionsAsync(ListFlowVersionsRequest, CancellationToken)

Returns a list of information about each flow. For more information, see Deploy a flow in Amazon Bedrock in the Amazon Bedrock User Guide.

Public Method ListIngestionJobs(ListIngestionJobsRequest)

Lists the data ingestion jobs for a data source. The list also includes information about each job.

Public Method ListIngestionJobsAsync(ListIngestionJobsRequest, CancellationToken)

Lists the data ingestion jobs for a data source. The list also includes information about each job.

Public Method ListKnowledgeBaseDocuments(ListKnowledgeBaseDocumentsRequest)

Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method ListKnowledgeBaseDocumentsAsync(ListKnowledgeBaseDocumentsRequest, CancellationToken)

Retrieves all the documents contained in a data source that is connected to a knowledge base. For more information, see Ingest changes directly into a knowledge base in the Amazon Bedrock User Guide.

Public Method ListKnowledgeBases(ListKnowledgeBasesRequest)

Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.

Public Method ListKnowledgeBasesAsync(ListKnowledgeBasesRequest, CancellationToken)

Lists the knowledge bases in an account. The list also includesinformation about each knowledge base.

Public Method ListPrompts(ListPromptsRequest)

Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.

Public Method ListPromptsAsync(ListPromptsRequest, CancellationToken)

Returns either information about the working draft (DRAFT version) of each prompt in an account, or information about of all versions of a prompt, depending on whether you include the promptIdentifier field or not. For more information, see View information about prompts using Prompt management in the Amazon Bedrock User Guide.

Public Method ListTagsForResource(ListTagsForResourceRequest)

List all the tags for the resource you specify.

Public Method ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

List all the tags for the resource you specify.

Public Method PrepareAgent(PrepareAgentRequest)

Creates a DRAFT version of the agent that can be used for internal testing.

Public Method PrepareAgentAsync(PrepareAgentRequest, CancellationToken)

Creates a DRAFT version of the agent that can be used for internal testing.

Public Method PrepareFlow(PrepareFlowRequest)

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.

Public Method PrepareFlowAsync(PrepareFlowRequest, CancellationToken)

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.

Public Method StartIngestionJob(StartIngestionJobRequest)

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Public Method StartIngestionJobAsync(StartIngestionJobRequest, CancellationToken)

Begins a data ingestion job. Data sources are ingested into your knowledge base so that Large Language Models (LLMs) can use your data.

Public Method StopIngestionJob(StopIngestionJobRequest)

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

Public Method StopIngestionJobAsync(StopIngestionJobRequest, CancellationToken)

Stops a currently running data ingestion job. You can send a StartIngestionJob request again to ingest the rest of your data when you are ready.

Public Method TagResource(TagResourceRequest)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method TagResourceAsync(TagResourceRequest, CancellationToken)

Associate tags with a resource. For more information, see Tagging resources in the Amazon Bedrock User Guide.

Public Method UntagResource(UntagResourceRequest)

Remove tags from a resource.

Public Method UntagResourceAsync(UntagResourceRequest, CancellationToken)

Remove tags from a resource.

Public Method UpdateAgent(UpdateAgentRequest)

Updates the configuration of an agent.

Public Method UpdateAgentActionGroup(UpdateAgentActionGroupRequest)

Updates the configuration for an action group for an agent.

Public Method UpdateAgentActionGroupAsync(UpdateAgentActionGroupRequest, CancellationToken)

Updates the configuration for an action group for an agent.

Public Method UpdateAgentAlias(UpdateAgentAliasRequest)

Updates configurations for an alias of an agent.

Public Method UpdateAgentAliasAsync(UpdateAgentAliasRequest, CancellationToken)

Updates configurations for an alias of an agent.

Public Method UpdateAgentAsync(UpdateAgentRequest, CancellationToken)

Updates the configuration of an agent.

Public Method UpdateAgentCollaborator(UpdateAgentCollaboratorRequest)

Updates an agent's collaborator.

Public Method UpdateAgentCollaboratorAsync(UpdateAgentCollaboratorRequest, CancellationToken)

Updates an agent's collaborator.

Public Method UpdateAgentKnowledgeBase(UpdateAgentKnowledgeBaseRequest)

Updates the configuration for a knowledge base that has been associated with an agent.

Public Method UpdateAgentKnowledgeBaseAsync(UpdateAgentKnowledgeBaseRequest, CancellationToken)

Updates the configuration for a knowledge base that has been associated with an agent.

Public Method UpdateDataSource(UpdateDataSourceRequest)

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.

Public Method UpdateDataSourceAsync(UpdateDataSourceRequest, CancellationToken)

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.

Public Method UpdateFlow(UpdateFlowRequest)

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.

Public Method UpdateFlowAlias(UpdateFlowAliasRequest)

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.

Public Method UpdateFlowAliasAsync(UpdateFlowAliasRequest, CancellationToken)

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.

Public Method UpdateFlowAsync(UpdateFlowRequest, CancellationToken)

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.

Public Method UpdateKnowledgeBase(UpdateKnowledgeBaseRequest)

Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.

You can change the following fields:

  • name

  • description

  • roleArn

You can't change the knowledgeBaseConfiguration or storageConfiguration fields, so you must specify the same configurations as when you created the knowledge base. You can send a GetKnowledgeBase request and copy the same configurations.

Public Method UpdateKnowledgeBaseAsync(UpdateKnowledgeBaseRequest, CancellationToken)

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.

Public Method UpdatePrompt(UpdatePromptRequest)

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.

Public Method UpdatePromptAsync(UpdatePromptRequest, CancellationToken)

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.

Public Method ValidateFlowDefinition(ValidateFlowDefinitionRequest)

Validates the definition of a flow.

Public Method ValidateFlowDefinitionAsync(ValidateFlowDefinitionRequest, CancellationToken)

Validates the definition of a flow.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5