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.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginAssociateAgentKnowledgeBase and EndAssociateAgentKnowledgeBase.

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

Syntax

C#
public virtual Task<AssociateAgentKnowledgeBaseResponse> AssociateAgentKnowledgeBaseAsync(
         AssociateAgentKnowledgeBaseRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.BedrockAgent.Model.AssociateAgentKnowledgeBaseRequest

Container for the necessary parameters to execute the AssociateAgentKnowledgeBase service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the AssociateAgentKnowledgeBase service method, as returned by BedrockAgent.

Exceptions

ExceptionCondition
AccessDeniedException The request is denied because of missing access permissions.
ConflictException There was a conflict performing an operation.
InternalServerException An internal server error occurred. Retry your request.
ResourceNotFoundException The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
ServiceQuotaExceededException The number of requests exceeds the service quota. Resubmit your request later.
ThrottlingException The number of requests exceeds the limit. Resubmit your request later.
ValidationException Input validation failed. Check your request parameters and retry the request.

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

See Also