DeleteAIPromptVersionCommand

Delete and Amazon Q in Connect AI Prompt version.

Example Syntax

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

import { QConnectClient, DeleteAIPromptVersionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, DeleteAIPromptVersionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // DeleteAIPromptVersionRequest
  assistantId: "STRING_VALUE", // required
  aiPromptId: "STRING_VALUE", // required
  versionNumber: Number("long"), // required
};
const command = new DeleteAIPromptVersionCommand(input);
const response = await client.send(command);
// {};

DeleteAIPromptVersionCommand Input

Parameter
Type
Description
aiPromptId
Required
string | undefined

The identifier of the Amazon Q in Connect AI prompt.

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.

versionNumber
Required
number | undefined

The version number of the AI Prompt version to be deleted.

DeleteAIPromptVersionCommand 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.

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.

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.