Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

create-email-template

Описание

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

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

Синтаксис

  create-email-template
--email-template-request <value>
--template-name <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]

Параметры

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

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

DefaultSubstitutions -> (строка)

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

HtmlPart -> (строка)

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

RecommenderId -> (строка)

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

Subject -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

Значение заголовка сообщения. Значение заголовка может содержать до 870 символов, включая длину любых рендеренных атрибутов. Например, если вы добавите атрибут {CreationDate}, он будет отображён как ГГГГ-ММ-ДДЧЧ:ММ:СС.ССЗ, и его длина составит 24 символа.

tags -> (карта)

Примечание

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

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

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 символов. Символами могут быть буквенно-цифровые символы, символы подчеркивания (_) или дефисы (-). Имена шаблонов чувствительны к регистру.

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

Вывод

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

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

Arn -> (строка)

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

Message -> (строка)

Сообщение, возвращаемое API для запроса на создание шаблона сообщения.

RequestID -> (строка)

Уникальный идентификатор запроса на создание шаблона сообщения.

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

Spec-Zone.ru

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