обновление-шаблона-сообщения-метаданные
Описание
Обновляет метаданные шаблона сообщения Amazon Q в Connect. Обратите внимание, что любые изменения имени, описания и конфигурации группировки шаблона сообщения будут применены к шаблону сообщения, указанному квалификатором $LATEST, и ко всем доступным версиям. Поддерживается частичное обновление. Если какое-либо поле не указано, оно останется неизменным для шаблона сообщения.
См. также: Документация AWS API
Синтаксис
update-message-template-metadata
--knowledge-base-id <value>
--message-template-id <value>
[--name <value>]
[--description <value>]
[--grouping-configuration <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 (строка)
--name (строка)
--description (строка)
--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", ...]
}
--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 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_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.