Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

RenderMessageTemplate - Amazon Connect

RenderMessageTemplate

Renders the Amazon Q in Connect message template based on the attribute values provided and generates the message content. For any variable present in the message template, if the attribute value is neither provided in the attribute request parameter nor the default attribute of the message template, the rendered message content will keep the variable placeholder as it is and return the attribute keys that are missing.

Request Syntax

POST /knowledgeBases/knowledgeBaseId/messageTemplates/messageTemplateId/render HTTP/1.1 Content-type: application/json { "attributes": { "agentAttributes": { "firstName": "string", "lastName": "string" }, "customAttributes": { "string" : "string" }, "customerProfileAttributes": { "accountNumber": "string", "additionalInformation": "string", "address1": "string", "address2": "string", "address3": "string", "address4": "string", "billingAddress1": "string", "billingAddress2": "string", "billingAddress3": "string", "billingAddress4": "string", "billingCity": "string", "billingCountry": "string", "billingCounty": "string", "billingPostalCode": "string", "billingProvince": "string", "billingState": "string", "birthDate": "string", "businessEmailAddress": "string", "businessName": "string", "businessPhoneNumber": "string", "city": "string", "country": "string", "county": "string", "custom": { "string" : "string" }, "emailAddress": "string", "firstName": "string", "gender": "string", "homePhoneNumber": "string", "lastName": "string", "mailingAddress1": "string", "mailingAddress2": "string", "mailingAddress3": "string", "mailingAddress4": "string", "mailingCity": "string", "mailingCountry": "string", "mailingCounty": "string", "mailingPostalCode": "string", "mailingProvince": "string", "mailingState": "string", "middleName": "string", "mobilePhoneNumber": "string", "partyType": "string", "phoneNumber": "string", "postalCode": "string", "profileARN": "string", "profileId": "string", "province": "string", "shippingAddress1": "string", "shippingAddress2": "string", "shippingAddress3": "string", "shippingAddress4": "string", "shippingCity": "string", "shippingCountry": "string", "shippingCounty": "string", "shippingPostalCode": "string", "shippingProvince": "string", "shippingState": "string", "state": "string" }, "systemAttributes": { "customerEndpoint": { "address": "string" }, "name": "string", "systemEndpoint": { "address": "string" } } } }

URI Request Parameters

The request uses the following URI parameters.

knowledgeBaseId

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

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$

Required: Yes

messageTemplateId

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

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(:[A-Z0-9_$]+){0,1}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}(:[A-Z0-9_$]+){0,1}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

attributes

An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.

Type: MessageTemplateAttributes object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "attachments": [ { "attachmentId": "string", "contentDisposition": "string", "name": "string", "uploadedTime": "string", "url": "string", "urlExpiry": "string" } ], "attributesNotInterpolated": [ "string" ], "content": { ... } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

attachments

The message template attachments.

Type: Array of MessageTemplateAttachment objects

attributesNotInterpolated

The attribute keys that are not resolved.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 32767.

content

The content of the message template.

Type: MessageTemplateContentProvider object

Note: This object is a Union. Only one member of this object can be specified or returned.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.