создать-шаблон-сообщения-версия
Описание
Создаёт новую версию шаблона сообщения Amazon Q в Connect из текущего содержимого и конфигурации шаблона сообщения. Версии неизменяемы и монотонно возрастают. После создания версии вы можете сослаться на определённую версию шаблона сообщения, передав <message-template-id>:<versionNumber> в качестве идентификатора шаблона сообщения. Ошибка отображается, если предоставленное messageTemplateContentSha256 отличается от messageTemplateContentSha256 шаблона сообщения с $LATEST квалификатором. Если несколько запросов CreateMessageTemplateVersion выполняются, пока шаблон сообщения остаётся неизменным, только первый вызов создаёт новую версию, а последующие запросы вернут тот же ответ, что и первый вызов.
См. также: Документация API AWS
Синтаксис
create-message-template-version
--knowledge-base-id <value>
--message-template-id <value>
[--message-template-content-sha256 <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 (строка)
--message-template-content-sha256 (строка)
$LATEST. Его можно получить в MessageTemplateData или ExtendedMessageTemplateData. Он рассчитывается по содержимому, языку, defaultAttributes и Attachments шаблона сообщения. Если не указано, версия шаблона сообщения будет создана на основе содержимого шаблона сообщения, на которое ссылается $LATEST квалификатор по умолчанию.--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.
Вывод
шаблонСообщения -> (структура)
Шаблон сообщения.
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 -> (список)
Типы атрибутов, содержащие шаблон сообщения.
(строка)
attachments -> (список)
Вложения шаблона сообщения.
(структура)
Информация о вложении шаблона сообщения.
contentDisposition -> (строка)
name -> (строка)
uploadedTime -> (метка времени)
url -> (строка)
urlExpiry -> (метка времени)
attachmentId -> (строка)
isActive -> (булево)
versionNumber -> (длинное целое)
messageTemplateContentSha256 -> (строка)
$LATEST. Оно может быть возвращено в MessageTemplateData или ExtendedMessageTemplateData. Оно рассчитывается по содержимому, языку, defaultAttributes и Attachments шаблона сообщения.tags -> (массив)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
key -> (строка)
value -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.