Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

обновление-шаблона-сообщения-метаданные

Описание

Обновляет метаданные шаблона сообщения 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 (строка)

Идентификатор базы знаний. Может быть либо идентификатором, либо ARN. URL-адреса не могут содержать ARN.

--message-template-id (строка)

Идентификатор шаблона сообщения. Может быть либо идентификатором, либо ARN. Не может содержать квалификатор.

--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 -> (строка)

Amazon Resource Name (ARN) шаблона сообщения.

messageTemplateId -> (строка)

Идентификатор шаблона сообщения.

knowledgeBaseArn -> (строка)

Amazon Resource Name (ARN) базы знаний.

knowledgeBaseId -> (строка)

Идентификатор базы знаний.

name -> (строка)

Название шаблона сообщения.

channelSubtype -> (строка)

Тип подканала, к которому относится этот шаблон сообщения.

createdTime -> (временная метка)

Временная метка создания шаблона сообщения.

lastModifiedTime -> (временная метка)

Временная метка последнего изменения данных шаблона сообщения.

lastModifiedBy -> (строка)

Amazon Resource Name (ARN) пользователя, который последний раз обновил данные шаблона сообщения.

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 -> (строка)

Имя агента, введённое в его учётной записи Amazon Connect.

lastName -> (строка)

Фамилия агента, введённая в его учётной записи Amazon Connect.

customerProfileAttributes -> (структура)

Атрибуты профиля клиента, используемые с шаблоном сообщения.

profileId -> (строка)

Уникальный идентификатор профиля клиента.

profileARN -> (строка)

ARN профиля клиента.

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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API