create-message-template
Описание
Создаёт шаблон сообщения Amazon Q в Connect. Название шаблона сообщения должно быть уникальным для каждой базы знаний. Тип канала шаблона сообщения неизменяем и не может быть изменён после создания. После создания шаблона сообщения можно использовать квалификатор $LATEST для ссылки на созданный шаблон сообщения.
См. также: AWS API документация
Синопсис
create-message-template
--knowledge-base-id <value>
--name <value>
--content <value>
[--description <value>]
--channel-subtype <value>
[--language <value>]
[--default-attributes <value>]
[--grouping-configuration <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--knowledge-base-id (строка)
--name (строка)
--content (структура помеченного объединения)
Содержание шаблона сообщения.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих верхнеуровневых ключей:email, sms.email -> (структура)
Содержимое шаблона сообщения, относящееся к типу канала электронной почты.
subject -> (строка)
body -> (структура)
Тело для использования в сообщениях электронной почты.
plainText -> (структура помеченного объединения)
Тело сообщения в формате простого текста для использования в сообщениях электронной почты, основанных на шаблоне сообщения. Рекомендуется использовать формат простого текста для почтовых клиентов, которые не отображают содержимое HTML, и клиентов, подключённых к сетям с высокой задержкой, таким как мобильные устройства.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих верхнеуровневых ключей:content.content -> (строка)
html -> (структура помеченного объединения)
Тело сообщения в формате HTML для использования в сообщениях электронной почты, основанных на шаблоне сообщения. Рекомендуется использовать формат HTML для почтовых клиентов, которые отображают содержимое HTML. В HTML-сообщении можно включать ссылки, форматированный текст и многое другое.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих верхнеуровневых ключей:content.content -> (строка)
headers -> (список)
Заголовки электронной почты для включения в сообщения электронной почты.
(структура)
Заголовок электронной почты для включения в сообщения электронной почты.
name -> (строка)
value -> (строка)
sms -> (структура)
Содержимое шаблона сообщения, относящееся к типу канала SMS.
body -> (структура)
Тело для использования в сообщениях SMS.
plainText -> (структура помеченного объединения)
Тело сообщения для использования в сообщениях SMS.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих верхнеуровневых ключей:content.content -> (строка)
Синтаксис JSON:
{
"email": {
"subject": "string",
"body": {
"plainText": {
"content": "string"
},
"html": {
"content": "string"
}
},
"headers": [
{
"name": "string",
"value": "string"
}
...
]
},
"sms": {
"body": {
"plainText": {
"content": "string"
}
}
}
}
--description (строка)
--channel-subtype (строка)
Тип канала, к которому относится этот шаблон сообщения.
Возможные значения:
EMAILSMS
--language (строка)
de_DE , en_US , es_ES , fr_FR , id_ID , it_IT , ja_JP , ko_KR , pt_BR , zh_CN , zh_TW
--default-attributes (структура)
Объект, определяющий значения по умолчанию для переменных в шаблоне сообщения. Этот объект содержит различные категории пар "ключ-значение". Каждый ключ определяет переменную или заполнитель в шаблоне сообщения. Соответствующее значение определяет значение по умолчанию для этой переменной.
systemAttributes -> (структура)
Системные атрибуты, используемые с шаблоном сообщения.
name -> (строка)
customerEndpoint -> (структура)
Атрибут CustomerEndpoint.
address -> (строка)
customerEndpoint, или номер, набранный клиентом для звонка в ваш контактный центр, если используется с systemEndpoint.systemEndpoint -> (структура)
Атрибут SystemEndpoint.
address -> (строка)
customerEndpoint, или номер, набранный клиентом для звонка в ваш контактный центр, если используется с systemEndpoint.agentAttributes -> (структура)
Атрибуты агента, используемые с шаблоном сообщения.
firstName -> (строка)
lastName -> (строка)
customerProfileAttributes -> (структура)
Атрибуты профиля клиента, используемые с шаблоном сообщения.
profileId -> (строка)
profileARN -> (строка)
firstName -> (строка)
middleName -> (строка)
lastName -> (строка)
accountNumber -> (строка)
emailAddress -> (строка)
phoneNumber -> (строка)
additionalInformation -> (строка)
partyType -> (строка)
businessName -> (строка)
birthDate -> (строка)
gender -> (строка)
mobilePhoneNumber -> (строка)
homePhoneNumber -> (строка)
businessPhoneNumber -> (строка)
businessEmailAddress -> (строка)
address1 -> (строка)
address2 -> (строка)
address3 -> (строка)
address4 -> (строка)
city -> (строка)
county -> (строка)
country -> (строка)
postalCode -> (строка)
province -> (строка)
state -> (строка)
shippingAddress1 -> (строка)
customAttributes -> (карта)
Сокращённый синтаксис:
systemAttributes={name=string,customerEndpoint={address=string},systemEndpoint={address=string}},agentAttributes={firstName=string,lastName=string},customerProfileAttributes={profileId=string,profileARN=string,firstName=string,middleName=string,lastName=string,accountNumber=string,emailAddress=string,phoneNumber=string,additionalInformation=string,partyType=string,businessName=string,birthDate=string,gender=string,mobilePhoneNumber=string,homePhoneNumber=string,businessPhoneNumber=string,businessEmailAddress=string,address1=string,address2=string,address3=string,address4=string,city=string,county=string,country=string,postalCode=string,province=string,state=string,shippingAddress1=string,shippingAddress2=string,shippingAddress3=string,shippingAddress4=string,shippingCity=string,shippingCounty=string,shippingCountry=string,shippingPostalCode=string,shippingProvince=string,shippingState=string,mailingAddress1=string,mailingAddress2=string,mailingAddress3=string,mailingAddress4=string,mailingCity=string,mailingCounty=string,mailingCountry=string,mailingPostalCode=string,mailingProvince=string,mailingState=string,billingAddress1=string,billingAddress2=string,billingAddress3=string,billingAddress4=string,billingCity=string,billingCounty=string,billingCountry=string,billingPostalCode=string,billingProvince=string,billingState=string,custom={KeyName1=string,KeyName2=string}},customAttributes={KeyName1=string,KeyName2=string}
Синтаксис JSON:
{
"systemAttributes": {
"name": "string",
"customerEndpoint": {
"address": "string"
},
"systemEndpoint": {
"address": "string"
}
},
"agentAttributes": {
"firstName": "string",
"lastName": "string"
},
"customerProfileAttributes": {
"profileId": "string",
"profileARN": "string",
"firstName": "string",
"middleName": "string",
"lastName": "string",
"accountNumber": "string",
"emailAddress": "string",
"phoneNumber": "string",
"additionalInformation": "string",
"partyType": "string",
"businessName": "string",
"birthDate": "string",
"gender": "string",
"mobilePhoneNumber": "string",
"homePhoneNumber": "string",
"businessPhoneNumber": "string",
"businessEmailAddress": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"county": "string",
"country": "string",
"postalCode": "string",
"province": "string",
"state": "string",
"shippingAddress1": "string",
"shippingAddress2": "string",
"shippingAddress3": "string",
"shippingAddress4": "string",
"shippingCity": "string",
"shippingCounty": "string",
"shippingCountry": "string",
"shippingPostalCode": "string",
"shippingProvince": "string",
"shippingState": "string",
"mailingAddress1": "string",
"mailingAddress2": "string",
"mailingAddress3": "string",
"mailingAddress4": "string",
"mailingCity": "string",
"mailingCounty": "string",
"mailingCountry": "string",
"mailingPostalCode": "string",
"mailingProvince": "string",
"mailingState": "string",
"billingAddress1": "string",
"billingAddress2": "string",
"billingAddress3": "string",
"billingAddress4": "string",
"billingCity": "string",
"billingCounty": "string",
"billingCountry": "string",
"billingPostalCode": "string",
"billingProvince": "string",
"billingState": "string",
"custom": {"string": "string"
...}
},
"customAttributes": {"string": "string"
...}
}
--grouping-configuration (структура)
Информация о конфигурации группировки пользователей Amazon Q в Connect.
criteria -> (строка)
Критерии, используемые для группировки пользователей Amazon Q в Connect.
Ниже приведен список поддерживаемых значений критериев.
-
RoutingProfileArn: Группировка пользователей по ARN профиля маршрутизации Amazon Connect. Пользователь должен иметь разрешения SearchRoutingProfile и DescribeRoutingProfile при установке критерия на это значение.
values -> (список)
Список значений, определяющих различные группы пользователей Amazon Q в Connect.
- При установке
criteriaнаRoutingProfileArn, необходимо указать список ARN профилей маршрутизации Amazon Connect в качестве значений этого параметра.
(строка)
Сокращенная синтаксическая запись:
criteria=string,values=string,string
Синтаксис JSON:
{
"criteria": "string",
"values": ["string", ...]
}
--client-token (строка)
--tags (массив)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
key -> (строка)
value -> (строка)
Сокращенная синтаксическая запись:
KeyName1=string,KeyName2=string
Синтаксис JSON:
{"string": "string"
...}
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного в JSON, поскольку строка будет интерпретироваться буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса к API. Если не указано значение или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команд и вернет пример выходного JSON для этой команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.
Глобальные параметры
--debug (логическое значение)
Включить отладку регистрации.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (логическое значение)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использование определенного профиля из файла учетных данных.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/выключение цветного вывода.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл сертификата CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет выполняться без блокировки и без таймаута. Значение по умолчанию — 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной в base64 строки. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключение пейджера cli для вывода.
--cli-auto-prompt (логическое значение)
Автоматическое запрошенние параметров CLI.
--no-cli-auto-prompt (логическое значение)
Отключение автоматического запроса параметров CLI.
Вывод
messageTemplate -> (структура)
Шаблон сообщения.
messageTemplateArn -> (строка)
messageTemplateId -> (строка)
knowledgeBaseArn -> (строка)
knowledgeBaseId -> (строка)
name -> (строка)
channelSubtype -> (строка)
createdTime -> (временная метка)
lastModifiedTime -> (временная метка)
lastModifiedBy -> (строка)
content -> (структура помеченных объединений)
Содержимое шаблона сообщения.
Примечание
Это структура помеченных объединений. Только один из следующих верхнеуровневых ключей может быть задан:email, sms.email -> (структура)
Содержимое шаблона сообщения, применимое к подтипу канала электронной почты.
subject -> (строка)
body -> (структура)
Тело, используемое в электронных письмах.
plainText -> (структура помеченных объединений)
Тело сообщения в формате обычного текста для использования в электронных письмах, основанных на шаблоне сообщения. Рекомендуется использовать формат простого текста для почтовых клиентов, не отображающих HTML-содержимое, и клиентов, подключенных к сетям с высокой задержкой, например мобильным устройствам.
Примечание
Это структура помеченных объединений. Только один из следующих верхнеуровневых ключей может быть задан:content.content -> (строка)
html -> (структура помеченных объединений)
Тело сообщения в формате HTML для использования в электронных письмах, основанных на шаблоне сообщения. Рекомендуется использовать формат HTML для почтовых клиентов, отображающих HTML-содержимое. Вы можете включать ссылки, форматированный текст и многое другое в HTML-сообщение.
Примечание
Это структура помеченных объединений. Только один из следующих верхнеуровневых ключей может быть задан:content.content -> (строка)
headers -> (список)
Заголовки электронной почты для включения в электронные письма.
(структура)
Заголовок электронной почты для включения в электронные письма.
name -> (строка)
value -> (строка)
sms -> (структура)
Содержимое шаблона сообщения, применимое к подтипу канала SMS.
body -> (структура)
Тело, используемое в SMS-сообщениях.
plainText -> (структура помеченных объединений)
Тело сообщения для использования в SMS-сообщениях.
Примечание
Это структура помеченных объединений. Только один из следующих верхнеуровневых ключей может быть задан:content.content -> (строка)
description -> (строка)
language -> (строка)
de_DE, en_US, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, zh_TWgroupingConfiguration -> (структура)
Информация о конфигурации группировки пользователей Amazon Q в Connect.
criteria -> (строка)
Критерии, используемые для группировки пользователей Amazon Q в Connect.
Ниже приведен список поддерживаемых значений критериев.
-
RoutingProfileArn: Группировка пользователей по ARN профиля маршрутизации Amazon Connect. Пользователь должен иметь разрешения SearchRoutingProfile и DescribeRoutingProfile при установке критерия на это значение.
values -> (список)
Список значений, определяющих различные группы пользователей Amazon Q в Connect.
- При установке
criteriaнаRoutingProfileArn, необходимо указать список ARN профилей маршрутизации Amazon Connect в качестве значений этого параметра.
(строка)
defaultAttributes -> (структура)
Объект, задающий значения по умолчанию для переменных в шаблоне сообщения. Этот объект содержит различные категории пар ключ-значение. Каждый ключ определяет переменную или заполнитель в шаблоне сообщения. Соответствующее значение определяет значение по умолчанию для этой переменной.
systemAttributes -> (структура)
Атрибуты системы, используемые с шаблоном сообщения.
name -> (строка)
customerEndpoint -> (структура)
Атрибут CustomerEndpoint.
address -> (строка)
customerEndpoint, или номер, по которому клиент позвонил в ваш контактный центр, если используется с systemEndpoint.systemEndpoint -> (структура)
Атрибут SystemEndpoint.
address -> (строка)
customerEndpoint, или номер, по которому клиент позвонил в ваш контактный центр, если используется с systemEndpoint.agentAttributes -> (структура)
Атрибуты агента, используемые с шаблоном сообщения.
firstName -> (строка)
lastName -> (строка)
customerProfileAttributes -> (структура)
Атрибуты профиля клиента, используемые с шаблоном сообщения.
profileId -> (строка)
profileARN -> (строка)
firstName -> (строка)
middleName -> (строка)
lastName -> (строка)
accountNumber -> (строка)
emailAddress -> (строка)
phoneNumber -> (строка)
additionalInformation -> (строка)
partyType -> (строка)
businessName -> (строка)
birthDate -> (строка)
gender -> (строка)
mobilePhoneNumber -> (строка)
homePhoneNumber -> (строка)
businessPhoneNumber -> (строка)
businessEmailAddress -> (строка)
address1 -> (строка)
address2 -> (строка)
address3 -> (строка)
address4 -> (строка)
city -> (строка)
county -> (строка)
country -> (строка)
postalCode -> (строка)
province -> (строка)
state -> (строка)
shippingAddress1 -> (строка)
shippingAddress2 -> (строка)
shippingAddress3 -> (строка)
shippingAddress4 -> (строка)
shippingCity -> (строка)
shippingCounty -> (строка)
shippingCountry -> (строка)
shippingPostalCode -> (строка)
shippingProvince -> (строка)
shippingState -> (строка)
mailingAddress1 -> (строка)
mailingAddress2 -> (строка)
mailingAddress3 -> (строка)
mailingAddress4 -> (строка)
mailingCity -> (строка)
mailingCounty -> (строка)
mailingCountry -> (строка)
mailingPostalCode -> (строка)
mailingProvince -> (строка)
mailingState -> (строка)
billingAddress1 -> (строка)
billingAddress2 -> (строка)
billingAddress3 -> (строка)
billingAddress4 -> (строка)
billingCity -> (строка)
billingCounty -> (строка)
billingCountry -> (строка)
billingPostalCode -> (строка)
billingProvince -> (строка)
billingState -> (строка)
custom -> (массив)
Пользовательские атрибуты в атрибутах профиля клиента.
key -> (строка)
value -> (строка)
customAttributes -> (массив)
Пользовательские атрибуты, используемые с шаблоном сообщения.
key -> (строка)
value -> (строка)
attributeTypes -> (список)
Типы атрибутов, содержащихся в шаблоне сообщения.
(строка)
messageTemplateContentSha256 -> (строка)
$LATEST. Может быть возвращено в MessageTemplateData или ExtendedMessageTemplateData. Вычисляется по содержимому, языку, defaultAttributes и Attachments шаблона сообщения.tags -> (массив)
Теги, используемые для организации, отслеживания или управления доступом к данному ресурсу.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.