- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
DeleteAssistantCommand
Deletes an assistant.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, DeleteAssistantCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, DeleteAssistantCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // DeleteAssistantRequest
assistantId: "STRING_VALUE", // required
};
const command = new DeleteAssistantCommand(input);
const response = await client.send(command);
// {};
DeleteAssistantCommand Input
See DeleteAssistantCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
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. |
DeleteAssistantCommand Output
See DeleteAssistantCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AccessDeniedException | client | You do not have sufficient access to perform this action. |
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. |