DeleteKnowledgeBaseCommand

Suggest an Edit

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations  DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration  and CreateDataIntegration  in the Amazon AppIntegrations API Reference.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QConnectClient, DeleteKnowledgeBaseCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, DeleteKnowledgeBaseCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // DeleteKnowledgeBaseRequest
  knowledgeBaseId: "STRING_VALUE", // required
};
const command = new DeleteKnowledgeBaseCommand(input);
const response = await client.send(command);
// {};

DeleteKnowledgeBaseCommand Input

See DeleteKnowledgeBaseCommandInput for more details

Parameter
Type
Description
knowledgeBaseId
Required
string | undefined

The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.

DeleteKnowledgeBaseCommand Output

See DeleteKnowledgeBaseCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ResourceNotFoundException
client

The specified resource does not exist.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.