Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

обновить-шаблон-электронной-почты

Описание

Обновляет существующий шаблон сообщения для сообщений, отправляемых через канал электронной почты.

См. также: Документацию API AWS

Синтаксис

  update-email-template
[--create-new-version | --no-create-new-version]
--email-template-request <value>
--template-name <value>
[--template-version <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]

Параметры

--create-new-version | --no-create-new-version (булево)

Указывает, нужно ли сохранить обновления в виде новой версии шаблона сообщения. Допустимые значения: true, сохранить обновления в виде новой версии; и false, сохранить обновления в (перезаписать) последней существующей версии шаблона.

Если вы не укажете значение для этого параметра, Amazon Pinpoint сохранит обновления в (перезапишет) последнюю существующую версию шаблона. Если вы укажете значение true для этого параметра, не указывайте значение для параметра version. В противном случае произойдет ошибка.

--email-template-request (структура)

Указывает содержимое и настройки шаблона сообщения, который можно использовать в сообщениях, отправляемых через канал электронной почты.

DefaultSubstitutions -> (строка)

Объект JSON, определяющий значения по умолчанию для переменных сообщений в шаблоне сообщения. Этот объект представляет собой набор пар «ключ-значение». Каждый ключ определяет переменную сообщения в шаблоне. Соответствующее значение определяет значение по умолчанию для этой переменной. При создании сообщения на основе шаблона вы можете переопределить эти значения по умолчанию с помощью переменных и значений, специфичных для сообщения и адреса.

HtmlPart -> (строка)

Тело сообщения в формате HTML для использования в сообщениях электронной почты, основанных на шаблоне сообщения. Рекомендуется использовать формат HTML для почтовых клиентов, которые отображают содержимое HTML. Вы можете включать ссылки, форматированный текст и многое другое в HTML-сообщение.

RecommenderId -> (строка)

Уникальный идентификатор модели рекомендаций для использования в шаблоне сообщения. Amazon Pinpoint использует это значение для определения того, как извлекать и обрабатывать данные из модели рекомендаций при отправке сообщений, использующих шаблон, если шаблон содержит переменные сообщения для данных рекомендаций.

Subject -> (строка)

Заголовок или тема для использования в сообщениях электронной почты, основанных на шаблоне сообщения.

Headers -> (список)

Список MessageHeaders для электронной почты. Вы можете иметь до 15 заголовков.

(структура)

Содержит пару «имя-значение» заголовка электронной почты, который нужно добавить к вашей электронной почте. Вы можете иметь до 15 MessageHeaders. Заголовок может содержать информацию, такую как отправитель, получатель, маршрут или метка времени.

Name -> (строка)

Имя заголовка сообщения. Имя заголовка может содержать до 126 символов.

Value -> (строка)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину рендеренных атрибутов. Например, если вы добавите атрибут {CreationDate}, он отображается как YYYY-MM-DDTHH:MM:SS.SSSZ и имеет длину 24 символа.

tags -> (карта)

Примечание

Начиная с 22-05-2023, теги устарели для операций обновления. После этой даты любое значение в тегах не обрабатывается, и код ошибки не возвращается. Для управления тегами рекомендуется использовать либо теги в Справочнике по API Amazon Pinpoint, команды resourcegroupstaggingapi в Документации AWS Command Line Interface или resourcegroupstaggingapi в SDK AWS.

(Устарело) Карта строка-строка пар «ключ-значение», определяющая теги для ассоциации с шаблоном сообщения. Каждый тег состоит из требуемого ключа тега и связанного со значением тега.

key -> (строка)

value -> (строка)

TemplateDescription -> (строка)

Пользовательское описание шаблона сообщения.

TextPart -> (строка)

Тело сообщения в формате простого текста для использования в сообщениях электронной почты, основанных на шаблоне сообщения. Рекомендуется использовать формат простого текста для почтовых клиентов, которые не отображают содержимое HTML, и для клиентов, подключенных к сетям с высокой задержкой, таким как мобильные устройства.

Краткая форма записи:

DefaultSubstitutions=string,HtmlPart=string,RecommenderId=string,Subject=string,Headers=[{Name=string,Value=string},{Name=string,Value=string}],tags={KeyName1=string,KeyName2=string},TemplateDescription=string,TextPart=string

Синтаксис JSON:

{
  "DefaultSubstitutions": "string",
  "HtmlPart": "string",
  "RecommenderId": "string",
  "Subject": "string",
  "Headers": [
    {
      "Name": "string",
      "Value": "string"
    }
    ...
  ],
  "tags": {"string": "string"
    ...},
  "TemplateDescription": "string",
  "TextPart": "string"
}

--template-name (строка)

Название шаблона сообщения. Название шаблона должно начинаться с буквенно-цифрового символа и может содержать максимум 128 символов. Символами могут быть буквенно-цифровые символы, подчеркивания (_) или дефисы (-). Имена шаблонов чувствительны к регистру.

--template-version (строка)

Уникальный идентификатор версии шаблона сообщения для обновления, получения информации или удаления. Чтобы получить идентификаторы и другую информацию обо всех версиях шаблона, используйте ресурс Template Versions.

Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Если указано для операции обновления, это значение должно соответствовать идентификатору последней существующей версии шаблона. Это ограничение помогает предотвратить возникновение конкурентных условий.

Если вы не укажете значение для этого параметра, Amazon Pinpoint выполнит следующие действия:

  • Для операции получения извлекает информацию о действующей версии шаблона.
  • Для операции обновления сохраняет обновления в (перезаписывает) последнюю существующую версию шаблона, если параметр create-new-version не используется или установлен в false.
  • Для операции удаления удаляет шаблон, включая все версии шаблона.

--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.

Вывод

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

Предоставляет информацию об API-запросе или ответе.

Message -> (строка)

Сообщение, возвращаемое от API.

RequestID -> (строка)

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

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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