update-message-template
Описание
Обновляет шаблон сообщения Amazon Q в Connect. Поддерживается частичное обновление. Если какой-либо поле не указано, оно останется без изменений для шаблона сообщения, на который ссылается квалификатор $LATEST. Любое изменение будет применяться только к шаблону сообщения, на который ссылается квалификатор $LATEST. Поля для всех доступных версий останутся неизменными.
См. также: Документацию API AWS
Синтаксис
update-message-template
--knowledge-base-id <value>
--message-template-id <value>
[--content <value>]
[--language <value>]
[--default-attributes <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 (строка)
--message-template-id (строка)
--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"
}
}
}
}
--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 -> (строка)
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 -> (строка)
Упрощённый синтаксис:
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"
...}
}
--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
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- вкл
- выкл
- авто
--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 версии 1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, сопоставляемого с двоичным блоком, 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_TW
groupingConfiguration -> (структура)
Справочная информация о группировке пользователей 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.