ListMessageTemplateVersionsCommand

Lists all the available versions for the specified Amazon Q in Connect message template.

Example Syntax

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

import { QConnectClient, ListMessageTemplateVersionsCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, ListMessageTemplateVersionsCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // ListMessageTemplateVersionsRequest
  knowledgeBaseId: "STRING_VALUE", // required
  messageTemplateId: "STRING_VALUE", // required
  nextToken: "STRING_VALUE",
  maxResults: Number("int"),
};
const command = new ListMessageTemplateVersionsCommand(input);
const response = await client.send(command);
// { // ListMessageTemplateVersionsResponse
//   messageTemplateVersionSummaries: [ // MessageTemplateVersionSummaryList // required
//     { // MessageTemplateVersionSummary
//       messageTemplateArn: "STRING_VALUE", // required
//       messageTemplateId: "STRING_VALUE", // required
//       knowledgeBaseArn: "STRING_VALUE", // required
//       knowledgeBaseId: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       channelSubtype: "STRING_VALUE", // required
//       isActive: true || false, // required
//       versionNumber: Number("long"), // required
//     },
//   ],
//   nextToken: "STRING_VALUE",
// };

ListMessageTemplateVersionsCommand Input

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. It cannot contain any qualifier.

maxResults
number | undefined

The maximum number of results to return per page.

nextToken
string | undefined

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

ListMessageTemplateVersionsCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
messageTemplateVersionSummaries
Required
MessageTemplateVersionSummary[] | undefined

Summary information about the versions of a message template.

nextToken
string | undefined

If there are additional results, this is the token for the next set of results.

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.