- 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.
RemoveAssistantAIAgentCommand
Removes the AI Agent that is set for use by default on an Amazon Q in Connect Assistant.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, RemoveAssistantAIAgentCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, RemoveAssistantAIAgentCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // RemoveAssistantAIAgentRequest
assistantId: "STRING_VALUE", // required
aiAgentType: "STRING_VALUE", // required
};
const command = new RemoveAssistantAIAgentCommand(input);
const response = await client.send(command);
// {};
RemoveAssistantAIAgentCommand Input
See RemoveAssistantAIAgentCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
aiAgentType Required | AIAgentType | undefined | The type of the AI Agent being removed for use by default from the Amazon Q in Connect Assistant. |
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. |
RemoveAssistantAIAgentCommand Output
See RemoveAssistantAIAgentCommandOutput 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. |
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. |