Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-email-template

Описание

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

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

Синтаксис

  get-email-template
--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]

Параметры

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

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

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

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

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

Если вы не укажете значение для этого параметра, 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
  • text
  • таблица
  • 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.

Вывод

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

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

Arn -> (строка)

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

CreationDate -> (строка)

Дата создания шаблона сообщения в формате ISO 8601.

DefaultSubstitutions -> (строка)

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

HtmlPart -> (строка)

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

LastModifiedDate -> (строка)

Дата последнего изменения шаблона сообщения в формате ISO 8601.

RecommenderId -> (строка)

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

Subject -> (строка)

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

Headers -> (список)

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

(структура)

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

Name -> (строка)

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

Value -> (строка)

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

tags -> (карта)

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

key -> (строка)

value -> (строка)

TemplateDescription -> (строка)

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

TemplateName -> (строка)

Имя шаблона сообщения.

TemplateType -> (строка)

Тип канала, для которого предназначен шаблон сообщения. Для шаблона электронной почты это значение EMAIL.

TextPart -> (строка)

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

Version -> (строка)

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

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

Spec-Zone.ru

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