- 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.
ListMessageTemplatesCommand
Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { QConnectClient, ListMessageTemplatesCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, ListMessageTemplatesCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // ListMessageTemplatesRequest
nextToken: "STRING_VALUE",
maxResults: Number("int"),
knowledgeBaseId: "STRING_VALUE", // required
};
const command = new ListMessageTemplatesCommand(input);
const response = await client.send(command);
// { // ListMessageTemplatesResponse
// messageTemplateSummaries: [ // MessageTemplateSummaryList // required
// { // MessageTemplateSummary
// messageTemplateArn: "STRING_VALUE", // required
// messageTemplateId: "STRING_VALUE", // required
// knowledgeBaseArn: "STRING_VALUE", // required
// knowledgeBaseId: "STRING_VALUE", // required
// name: "STRING_VALUE", // required
// channelSubtype: "STRING_VALUE", // required
// createdTime: new Date("TIMESTAMP"), // required
// lastModifiedTime: new Date("TIMESTAMP"), // required
// lastModifiedBy: "STRING_VALUE", // required
// activeVersionNumber: Number("long"),
// description: "STRING_VALUE",
// tags: { // Tags
// "<keys>": "STRING_VALUE",
// },
// },
// ],
// nextToken: "STRING_VALUE",
// };
ListMessageTemplatesCommand Input
Parameter | Type | Description |
---|
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. |
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. |
ListMessageTemplatesCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
messageTemplateSummaries Required | MessageTemplateSummary[] | undefined | Summary information about the message template. |
nextToken | string | undefined | If there are additional results, this is the token for the next set of results. |
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. |