DeleteMessageTemplateCommand

Suggest an Edit

Deletes an Amazon Q in Connect message template entirely or a specific version of the message template if version is supplied in the request. You can provide the message template identifier as <message-template-id>:<versionNumber> to delete a specific version of the message template. If it is not supplied, the message template and all available versions will be deleted.

Example Syntax

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

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

DeleteMessageTemplateCommand Input

See DeleteMessageTemplateCommandInput for more details

Parameter
Type
Description
knowledgeBaseId
Required
string | undefined

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

messageTemplateId
Required
string | undefined

The identifier of the message template. Can be either the ID or the ARN.

DeleteMessageTemplateCommand Output

See DeleteMessageTemplateCommandOutput 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.

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.