DeleteAIAgentCommand

Deletes an Amazon Q in Connect AI Agent.

Example Syntax

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

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

DeleteAIAgentCommand Input

See DeleteAIAgentCommandInput for more details

Parameter
Type
Description
aiAgentId
Required
string | undefined

The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs cannot contain the ARN.

assistantId
Required
string | undefined

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

DeleteAIAgentCommand Output

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.

ResourceNotFoundException
client

The specified resource does not exist.

ThrottlingException
client

The throttling limit has been exceeded.

ValidationException
client

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

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