2024/11/18 - Amazon Q Connect - 14 new api methods
Changes This release introduces MessageTemplate as a resource in Amazon Q in Connect, along with APIs to create, read, search, update, and delete MessageTemplate resources.
Activates a specific version of the Amazon Q in Connect message template. After the version is activated, the previous active version will be deactivated automatically. You can use the $ACTIVE_VERSION qualifier later to reference the version that is in active status.
See also: AWS API Documentation
Request Syntax
client.activate_message_template(
knowledgeBaseId='string',
messageTemplateId='string',
versionNumber=123
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
integer
[REQUIRED]
The version number of the message template version to activate.
dict
Response Syntax
{
'messageTemplateArn': 'string',
'messageTemplateId': 'string',
'versionNumber': 123
}
Response Structure
(dict) --
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateId (string) --
The identifier of the message template.
versionNumber (integer) --
The version number of the message template version that is activated.
Retrieves the Amazon Q in Connect message template. The message template identifier can contain an optional qualifier, for example, <message-template-id>:<qualifier>, which is either an actual version number or an Amazon Q Connect managed qualifier $ACTIVE_VERSION | $LATEST. If it is not supplied, then $LATEST is assumed implicitly.
See also: AWS API Documentation
Request Syntax
client.get_message_template(
knowledgeBaseId='string',
messageTemplateId='string'
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN.
dict
Response Syntax
{
'messageTemplate': {
'attachments': [
{
'attachmentId': 'string',
'contentDisposition': 'ATTACHMENT',
'name': 'string',
'uploadedTime': datetime(2015, 1, 1),
'url': 'string',
'urlExpiry': datetime(2015, 1, 1)
},
],
'attributeTypes': [
'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM',
],
'channelSubtype': 'EMAIL'|'SMS',
'content': {
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
'createdTime': datetime(2015, 1, 1),
'defaultAttributes': {
'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'
}
}
},
'description': 'string',
'groupingConfiguration': {
'criteria': 'string',
'values': [
'string',
]
},
'isActive': True|False,
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'language': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateContentSha256': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'versionNumber': 123
}
}
Response Structure
(dict) --
messageTemplate (dict) --
The message template.
attachments (list) --
The message template attachments.
(dict) --
Information about the message template attachment.
attachmentId (string) --
The identifier of the attachment file.
contentDisposition (string) --
The presentation information for the attachment file.
name (string) --
The name of the attachment file being uploaded. The name should include the file extension.
uploadedTime (datetime) --
The timestamp when the attachment file was uploaded.
url (string) --
A pre-signed Amazon S3 URL that can be used to download the attachment file.
urlExpiry (datetime) --
The expiration time of the pre-signed Amazon S3 URL.
attributeTypes (list) --
The types of attributes contain the message template.
(string) --
channelSubtype (string) --
The channel subtype this message template applies to.
content (dict) --
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
createdTime (datetime) --
The timestamp when the message template was created.
defaultAttributes (dict) --
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
description (string) --
The description of the message template.
groupingConfiguration (dict) --
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
isActive (boolean) --
Whether the version of the message template is activated.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
language (string) --
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateContentSha256 (string) --
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
versionNumber (integer) --
The version number of the message template version.
Deletes the attachment file from the Amazon Q in Connect message template that is referenced by $LATEST qualifier. Attachments on available message template versions will remain unchanged.
See also: AWS API Documentation
Request Syntax
client.delete_message_template_attachment(
attachmentId='string',
knowledgeBaseId='string',
messageTemplateId='string'
)
string
[REQUIRED]
The identifier of the attachment file.
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
dict
Response Syntax
{}
Response Structure
(dict) --
Updates the Amazon Q in Connect message template metadata. Note that any modification to the message template’s name, description and grouping configuration will applied to the message template pointed by the $LATEST qualifier and all available versions. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template.
See also: AWS API Documentation
Request Syntax
client.update_message_template_metadata(
description='string',
groupingConfiguration={
'criteria': 'string',
'values': [
'string',
]
},
knowledgeBaseId='string',
messageTemplateId='string',
name='string'
)
string
The description of the message template.
dict
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
string
The name of the message template.
dict
Response Syntax
{
'messageTemplate': {
'attributeTypes': [
'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM',
],
'channelSubtype': 'EMAIL'|'SMS',
'content': {
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
'createdTime': datetime(2015, 1, 1),
'defaultAttributes': {
'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'
}
}
},
'description': 'string',
'groupingConfiguration': {
'criteria': 'string',
'values': [
'string',
]
},
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'language': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateContentSha256': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
messageTemplate (dict) --
The message template.
attributeTypes (list) --
The types of attributes that the message template contains.
(string) --
channelSubtype (string) --
The channel subtype this message template applies to.
content (dict) --
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
createdTime (datetime) --
The timestamp when the message template was created.
defaultAttributes (dict) --
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
description (string) --
The description of the message template.
groupingConfiguration (dict) --
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
language (string) --
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateContentSha256 (string) --
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Lists all the available versions for the specified Amazon Q in Connect message template.
See also: AWS API Documentation
Request Syntax
client.list_message_template_versions(
knowledgeBaseId='string',
maxResults=123,
messageTemplateId='string',
nextToken='string'
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
integer
The maximum number of results to return per page.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
string
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.
dict
Response Syntax
{
'messageTemplateVersionSummaries': [
{
'channelSubtype': 'EMAIL'|'SMS',
'isActive': True|False,
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'messageTemplateArn': 'string',
'messageTemplateId': 'string',
'name': 'string',
'versionNumber': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
messageTemplateVersionSummaries (list) --
Summary information about the versions of a message template.
(dict) --
The summary of the message template version.
channelSubtype (string) --
The channel subtype this message template applies to.
isActive (boolean) --
Whether the version of the message template is activated.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
versionNumber (integer) --
The version number of the message template version.
nextToken (string) --
If there are additional results, this is the token for the next set of results.
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.
See also: AWS API Documentation
Request Syntax
client.render_message_template(
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'
}
}
},
knowledgeBaseId='string',
messageTemplateId='string'
)
dict
[REQUIRED]
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.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN.
dict
Response Syntax
{
'attachments': [
{
'attachmentId': 'string',
'contentDisposition': 'ATTACHMENT',
'name': 'string',
'uploadedTime': datetime(2015, 1, 1),
'url': 'string',
'urlExpiry': datetime(2015, 1, 1)
},
],
'attributesNotInterpolated': [
'string',
],
'content': {
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
}
}
Response Structure
(dict) --
attachments (list) --
The message template attachments.
(dict) --
Information about the message template attachment.
attachmentId (string) --
The identifier of the attachment file.
contentDisposition (string) --
The presentation information for the attachment file.
name (string) --
The name of the attachment file being uploaded. The name should include the file extension.
uploadedTime (datetime) --
The timestamp when the attachment file was uploaded.
url (string) --
A pre-signed Amazon S3 URL that can be used to download the attachment file.
urlExpiry (datetime) --
The expiration time of the pre-signed Amazon S3 URL.
attributesNotInterpolated (list) --
The attribute keys that are not resolved.
(string) --
content (dict) --
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
Searches for Amazon Q in Connect message templates in the specified knowledge base.
See also: AWS API Documentation
Request Syntax
client.search_message_templates(
knowledgeBaseId='string',
maxResults=123,
nextToken='string',
searchExpression={
'filters': [
{
'includeNoExistence': True|False,
'name': 'string',
'operator': 'EQUALS'|'PREFIX',
'values': [
'string',
]
},
],
'orderOnField': {
'name': 'string',
'order': 'ASC'|'DESC'
},
'queries': [
{
'allowFuzziness': True|False,
'name': 'string',
'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX',
'priority': 'HIGH'|'MEDIUM'|'LOW',
'values': [
'string',
]
},
]
}
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
integer
The maximum number of results to return per page.
string
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.
dict
[REQUIRED]
The search expression for querying the message template.
filters (list) --
The configuration of filtering rules applied to message template query results.
(dict) --
The message template fields to filter the message template query results by. The following is the list of supported field names:
name
description
channel
channelSubtype
language
qualifier
createdTime
lastModifiedTime
lastModifiedBy
groupingConfiguration.criteria
groupingConfiguration.values
includeNoExistence (boolean) --
Whether to treat null value as a match for the attribute field.
name (string) -- [REQUIRED]
The name of the attribute field to filter the message templates by.
operator (string) -- [REQUIRED]
The operator to use for filtering.
values (list) --
The values of attribute field to filter the message template by.
(string) --
orderOnField (dict) --
The message template attribute fields on which the query results are ordered.
name (string) -- [REQUIRED]
The name of the message template.
order (string) --
The order at which the message templates are sorted by.
queries (list) --
The message template query expressions.
(dict) --
The message template fields to query message templates by. The following is the list of supported field names:
name
description
allowFuzziness (boolean) --
Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
name (string) -- [REQUIRED]
The name of the attribute to query the message templates by.
operator (string) -- [REQUIRED]
The operator to use for matching attribute field values in the query.
priority (string) --
The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
values (list) -- [REQUIRED]
The values of the attribute to query the message templates by.
(string) --
dict
Response Syntax
{
'nextToken': 'string',
'results': [
{
'channelSubtype': 'EMAIL'|'SMS',
'createdTime': datetime(2015, 1, 1),
'description': 'string',
'groupingConfiguration': {
'criteria': 'string',
'values': [
'string',
]
},
'isActive': True|False,
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'language': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'versionNumber': 123
},
]
}
Response Structure
(dict) --
nextToken (string) --
If there are additional results, this is the token for the next set of results.
results (list) --
The results of the message template search.
(dict) --
The result of message template search.
channelSubtype (string) --
The channel subtype this message template applies to.
createdTime (datetime) --
The timestamp when the message template was created.
description (string) --
The description of the message template.
groupingConfiguration (dict) --
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
isActive (boolean) --
Whether the version of the message template is activated.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
language (string) --
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
versionNumber (integer) --
The version number of the message template version.
Lists all the available Amazon Q in Connect message templates for the specified knowledge base.
See also: AWS API Documentation
Request Syntax
client.list_message_templates(
knowledgeBaseId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
integer
The maximum number of results to return per page.
string
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.
dict
Response Syntax
{
'messageTemplateSummaries': [
{
'activeVersionNumber': 123,
'channelSubtype': 'EMAIL'|'SMS',
'createdTime': datetime(2015, 1, 1),
'description': 'string',
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
messageTemplateSummaries (list) --
Summary information about the message template.
(dict) --
The summary of the message template.
activeVersionNumber (integer) --
The version number of the message template version that is activated.
channelSubtype (string) --
The channel subtype this message template applies to.
createdTime (datetime) --
The timestamp when the message template was created.
description (string) --
The description of the message template.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
nextToken (string) --
If there are additional results, this is the token for the next set of results.
Updates the Amazon Q in Connect message template. Partial update is supported. If any field is not supplied, it will remain unchanged for the message template that is referenced by the $LATEST qualifier. Any modification will only apply to the message template that is referenced by the $LATEST qualifier. The fields for all available versions will remain unchanged.
See also: AWS API Documentation
Request Syntax
client.update_message_template(
content={
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
defaultAttributes={
'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'
}
}
},
knowledgeBaseId='string',
language='string',
messageTemplateId='string'
)
dict
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
dict
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
dict
Response Syntax
{
'messageTemplate': {
'attributeTypes': [
'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM',
],
'channelSubtype': 'EMAIL'|'SMS',
'content': {
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
'createdTime': datetime(2015, 1, 1),
'defaultAttributes': {
'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'
}
}
},
'description': 'string',
'groupingConfiguration': {
'criteria': 'string',
'values': [
'string',
]
},
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'language': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateContentSha256': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
messageTemplate (dict) --
The message template.
attributeTypes (list) --
The types of attributes that the message template contains.
(string) --
channelSubtype (string) --
The channel subtype this message template applies to.
content (dict) --
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
createdTime (datetime) --
The timestamp when the message template was created.
defaultAttributes (dict) --
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
description (string) --
The description of the message template.
groupingConfiguration (dict) --
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
language (string) --
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateContentSha256 (string) --
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
Creates a new Amazon Q in Connect message template version from the current content and configuration of a message template. Versions are immutable and monotonically increasing. Once a version is created, you can reference a specific version of the message template by passing in <message-template-id>:<versionNumber> as the message template identifier. An error is displayed if the supplied messageTemplateContentSha256 is different from the messageTemplateContentSha256 of the message template with $LATEST qualifier. If multiple CreateMessageTemplateVersion requests are made while the message template remains the same, only the first invocation creates a new version and the succeeding requests will return the same response as the first invocation.
See also: AWS API Documentation
Request Syntax
client.create_message_template_version(
knowledgeBaseId='string',
messageTemplateContentSha256='string',
messageTemplateId='string'
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the $LATEST qualifier by default.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
dict
Response Syntax
{
'messageTemplate': {
'attachments': [
{
'attachmentId': 'string',
'contentDisposition': 'ATTACHMENT',
'name': 'string',
'uploadedTime': datetime(2015, 1, 1),
'url': 'string',
'urlExpiry': datetime(2015, 1, 1)
},
],
'attributeTypes': [
'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM',
],
'channelSubtype': 'EMAIL'|'SMS',
'content': {
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
'createdTime': datetime(2015, 1, 1),
'defaultAttributes': {
'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'
}
}
},
'description': 'string',
'groupingConfiguration': {
'criteria': 'string',
'values': [
'string',
]
},
'isActive': True|False,
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'language': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateContentSha256': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
},
'versionNumber': 123
}
}
Response Structure
(dict) --
messageTemplate (dict) --
The message template.
attachments (list) --
The message template attachments.
(dict) --
Information about the message template attachment.
attachmentId (string) --
The identifier of the attachment file.
contentDisposition (string) --
The presentation information for the attachment file.
name (string) --
The name of the attachment file being uploaded. The name should include the file extension.
uploadedTime (datetime) --
The timestamp when the attachment file was uploaded.
url (string) --
A pre-signed Amazon S3 URL that can be used to download the attachment file.
urlExpiry (datetime) --
The expiration time of the pre-signed Amazon S3 URL.
attributeTypes (list) --
The types of attributes contain the message template.
(string) --
channelSubtype (string) --
The channel subtype this message template applies to.
content (dict) --
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
createdTime (datetime) --
The timestamp when the message template was created.
defaultAttributes (dict) --
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
description (string) --
The description of the message template.
groupingConfiguration (dict) --
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
isActive (boolean) --
Whether the version of the message template is activated.
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
language (string) --
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateContentSha256 (string) --
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
versionNumber (integer) --
The version number of the message template version.
Uploads an attachment file to the specified Amazon Q in Connect message template. The name of the message template attachment has to be unique for each message template referenced by the $LATEST qualifier. The body of the attachment file should be encoded using base64 encoding. After the file is uploaded, you can use the pre-signed Amazon S3 URL returned in response to download the uploaded file.
See also: AWS API Documentation
Request Syntax
client.create_message_template_attachment(
body='string',
clientToken='string',
contentDisposition='ATTACHMENT',
knowledgeBaseId='string',
messageTemplateId='string',
name='string'
)
string
[REQUIRED]
The body of the attachment file being uploaded. It should be encoded using base64 encoding.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
string
[REQUIRED]
The presentation information for the attachment file.
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
string
[REQUIRED]
The name of the attachment file being uploaded. The name should include the file extension.
dict
Response Syntax
{
'attachment': {
'attachmentId': 'string',
'contentDisposition': 'ATTACHMENT',
'name': 'string',
'uploadedTime': datetime(2015, 1, 1),
'url': 'string',
'urlExpiry': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
attachment (dict) --
The message template attachment.
attachmentId (string) --
The identifier of the attachment file.
contentDisposition (string) --
The presentation information for the attachment file.
name (string) --
The name of the attachment file being uploaded. The name should include the file extension.
uploadedTime (datetime) --
The timestamp when the attachment file was uploaded.
url (string) --
A pre-signed Amazon S3 URL that can be used to download the attachment file.
urlExpiry (datetime) --
The expiration time of the pre-signed Amazon S3 URL.
Deactivates a specific version of the Amazon Q in Connect message template . After the version is deactivated, you can no longer use the $ACTIVE_VERSION qualifier to reference the version in active status.
See also: AWS API Documentation
Request Syntax
client.deactivate_message_template(
knowledgeBaseId='string',
messageTemplateId='string',
versionNumber=123
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.
integer
[REQUIRED]
The version number of the message template version to deactivate.
dict
Response Syntax
{
'messageTemplateArn': 'string',
'messageTemplateId': 'string',
'versionNumber': 123
}
Response Structure
(dict) --
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateId (string) --
The identifier of the message template.
versionNumber (integer) --
The version number of the message template version that has been deactivated.
Creates an Amazon Q in Connect message template. The name of the message template has to be unique for each knowledge base. The channel subtype of the message template is immutable and cannot be modified after creation. After the message template is created, you can use the $LATEST qualifier to reference the created message template.
See also: AWS API Documentation
Request Syntax
client.create_message_template(
channelSubtype='EMAIL'|'SMS',
clientToken='string',
content={
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
defaultAttributes={
'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'
}
}
},
description='string',
groupingConfiguration={
'criteria': 'string',
'values': [
'string',
]
},
knowledgeBaseId='string',
language='string',
name='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The channel subtype this message template applies to.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
This field is autopopulated if not provided.
dict
[REQUIRED]
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
dict
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
string
The description of the message template.
dict
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
string
[REQUIRED]
The name of the message template.
dict
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
dict
Response Syntax
{
'messageTemplate': {
'attributeTypes': [
'SYSTEM'|'AGENT'|'CUSTOMER_PROFILE'|'CUSTOM',
],
'channelSubtype': 'EMAIL'|'SMS',
'content': {
'email': {
'body': {
'html': {
'content': 'string'
},
'plainText': {
'content': 'string'
}
},
'headers': [
{
'name': 'string',
'value': 'string'
},
],
'subject': 'string'
},
'sms': {
'body': {
'plainText': {
'content': 'string'
}
}
}
},
'createdTime': datetime(2015, 1, 1),
'defaultAttributes': {
'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'
}
}
},
'description': 'string',
'groupingConfiguration': {
'criteria': 'string',
'values': [
'string',
]
},
'knowledgeBaseArn': 'string',
'knowledgeBaseId': 'string',
'language': 'string',
'lastModifiedBy': 'string',
'lastModifiedTime': datetime(2015, 1, 1),
'messageTemplateArn': 'string',
'messageTemplateContentSha256': 'string',
'messageTemplateId': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
}
}
Response Structure
(dict) --
messageTemplate (dict) --
The message template.
attributeTypes (list) --
The types of attributes that the message template contains.
(string) --
channelSubtype (string) --
The channel subtype this message template applies to.
content (dict) --
The content of the message template.
email (dict) --
The content of the message template that applies to the email channel subtype.
body (dict) --
The body to use in email messages.
html (dict) --
The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
content (string) --
The content of the message template.
plainText (dict) --
The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
content (string) --
The content of the message template.
headers (list) --
The email headers to include in email messages.
(dict) --
The email header to include in email messages.
name (string) --
The name of the email header.
value (string) --
The value of the email header.
subject (string) --
The subject line, or title, to use in email messages.
sms (dict) --
The content of the message template that applies to the SMS channel subtype.
body (dict) --
The body to use in SMS messages.
plainText (dict) --
The message body to use in SMS messages.
content (string) --
The content of the message template.
createdTime (datetime) --
The timestamp when the message template was created.
defaultAttributes (dict) --
An object that specifies the default 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 default value for that variable.
agentAttributes (dict) --
The agent attributes that are used with the message template.
firstName (string) --
The agent’s first name as entered in their Amazon Connect user account.
lastName (string) --
The agent’s last name as entered in their Amazon Connect user account.
customAttributes (dict) --
The custom attributes that are used with the message template.
(string) --
(string) --
customerProfileAttributes (dict) --
The customer profile attributes that are used with the message template.
accountNumber (string) --
A unique account number that you have given to the customer.
additionalInformation (string) --
Any additional information relevant to the customer's profile.
address1 (string) --
The first line of a customer address.
address2 (string) --
The second line of a customer address.
address3 (string) --
The third line of a customer address.
address4 (string) --
The fourth line of a customer address.
billingAddress1 (string) --
The first line of a customer’s billing address.
billingAddress2 (string) --
The second line of a customer’s billing address.
billingAddress3 (string) --
The third line of a customer’s billing address.
billingAddress4 (string) --
The fourth line of a customer’s billing address.
billingCity (string) --
The city of a customer’s billing address.
billingCountry (string) --
The country of a customer’s billing address.
billingCounty (string) --
The county of a customer’s billing address.
billingPostalCode (string) --
The postal code of a customer’s billing address.
billingProvince (string) --
The province of a customer’s billing address.
billingState (string) --
The state of a customer’s billing address.
birthDate (string) --
The customer's birth date.
businessEmailAddress (string) --
The customer's business email address.
businessName (string) --
The name of the customer's business.
businessPhoneNumber (string) --
The customer's business phone number.
city (string) --
The city in which a customer lives.
country (string) --
The country in which a customer lives.
county (string) --
The county in which a customer lives.
custom (dict) --
The custom attributes in customer profile attributes.
(string) --
(string) --
emailAddress (string) --
The customer's email address, which has not been specified as a personal or business address.
firstName (string) --
The customer's first name.
gender (string) --
The customer's gender.
homePhoneNumber (string) --
The customer's mobile phone number.
lastName (string) --
The customer's last name.
mailingAddress1 (string) --
The first line of a customer’s mailing address.
mailingAddress2 (string) --
The second line of a customer’s mailing address.
mailingAddress3 (string) --
The third line of a customer’s mailing address.
mailingAddress4 (string) --
The fourth line of a customer’s mailing address.
mailingCity (string) --
The city of a customer’s mailing address.
mailingCountry (string) --
The country of a customer’s mailing address.
mailingCounty (string) --
The county of a customer’s mailing address.
mailingPostalCode (string) --
The postal code of a customer’s mailing address.
mailingProvince (string) --
The province of a customer’s mailing address.
mailingState (string) --
The state of a customer’s mailing address.
middleName (string) --
The customer's middle name.
mobilePhoneNumber (string) --
The customer's mobile phone number.
partyType (string) --
The customer's party type.
phoneNumber (string) --
The customer's phone number, which has not been specified as a mobile, home, or business number.
postalCode (string) --
The postal code of a customer address.
profileARN (string) --
The ARN of a customer profile.
profileId (string) --
The unique identifier of a customer profile.
province (string) --
The province in which a customer lives.
shippingAddress1 (string) --
The first line of a customer’s shipping address.
shippingAddress2 (string) --
The second line of a customer’s shipping address.
shippingAddress3 (string) --
The third line of a customer’s shipping address.
shippingAddress4 (string) --
The fourth line of a customer’s shipping address.
shippingCity (string) --
The city of a customer’s shipping address.
shippingCountry (string) --
The country of a customer’s shipping address.
shippingCounty (string) --
The county of a customer’s shipping address.
shippingPostalCode (string) --
The postal code of a customer’s shipping address.
shippingProvince (string) --
The province of a customer’s shipping address.
shippingState (string) --
The state of a customer’s shipping address.
state (string) --
The state in which a customer lives.
systemAttributes (dict) --
The system attributes that are used with the message template.
customerEndpoint (dict) --
The CustomerEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
name (string) --
The name of the task.
systemEndpoint (dict) --
The SystemEndpoint attribute.
address (string) --
The customer's phone number if used with customerEndpoint, or the number the customer dialed to call your contact center if used with systemEndpoint.
description (string) --
The description of the message template.
groupingConfiguration (dict) --
The configuration information of the grouping of Amazon Q in Connect users.
criteria (string) --
The criteria used for grouping Amazon Q in Connect users.
The following is the list of supported criteria values.
RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
values (list) --
The list of values that define different groups of Amazon Q in Connect users.
When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
(string) --
knowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base.
knowledgeBaseId (string) --
The identifier of the knowledge base.
language (string) --
The language code value for the language in which the quick response is written. The supported language codes include de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TW
lastModifiedBy (string) --
The Amazon Resource Name (ARN) of the user who last updated the message template data.
lastModifiedTime (datetime) --
The timestamp when the message template data was last modified.
messageTemplateArn (string) --
The Amazon Resource Name (ARN) of the message template.
messageTemplateContentSha256 (string) --
The checksum value of the message template content that is referenced by the $LATEST qualifier. It can be returned in MessageTemplateData or ExtendedMessageTemplateData. It’s calculated by content, language, defaultAttributes and Attachments of the message template.
messageTemplateId (string) --
The identifier of the message template.
name (string) --
The name of the message template.
tags (dict) --
The tags used to organize, track, or control access for this resource.
(string) --
(string) --
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.
See also: AWS API Documentation
Request Syntax
client.delete_message_template(
knowledgeBaseId='string',
messageTemplateId='string'
)
string
[REQUIRED]
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
string
[REQUIRED]
The identifier of the message template. Can be either the ID or the ARN.
dict
Response Syntax
{}
Response Structure
(dict) --