Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

Получение шаблона в приложении

Описание

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

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

Синтаксис

  get-in-app-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 выполнит следующие действия:

  • Для операции получения извлекает информацию о текущей версии шаблона.
  • Для операции обновления сохраняет обновления в (перезаписывает) последнюю существующую версию шаблона, если параметр создать-новую-версию не используется или установлен в значение 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.

Вывод

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

Ответ шаблона в приложении.

Arn -> (строка)

ARN ресурса шаблона.

Content -> (список)

Содержимое сообщения, может включать до 5 модальных окон. Каждое модальное окно должно содержать сообщение, заголовок и цвет фона. ImageUrl и кнопки являются необязательными.

(структура)

Настройка содержимого сообщения.

BackgroundColor -> (строка)

Цвет фона сообщения.

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

Настройка тела сообщения.

Alignment -> (строка)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Body -> (строка)

Тело сообщения.

TextColor -> (строка)

Цвет текста.

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

Настройка заголовка сообщения.

Alignment -> (строка)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Header -> (строка)

Заголовок сообщения.

TextColor -> (строка)

Цвет текста.

ImageUrl -> (строка)

URL изображения для фона сообщения.

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

Первая кнопка в сообщении.

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

Содержимое кнопки по умолчанию.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

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

Содержимое кнопки по умолчанию.

BackgroundColor -> (строка)

Цвет фона кнопки.

BorderRadius -> (целое число)

Радиус скругления границ кнопки.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

Text -> (строка)

Текст кнопки.

TextColor -> (строка)

Цвет текста кнопки.

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

Содержимое кнопки по умолчанию.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

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

Содержимое кнопки по умолчанию.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

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

Вторая кнопка в сообщении.

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

Содержимое кнопки по умолчанию.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

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

Содержимое кнопки по умолчанию.

BackgroundColor -> (строка)

Цвет фона кнопки.

BorderRadius -> (целое число)

Радиус скругления границ кнопки.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

Text -> (строка)

Текст кнопки.

TextColor -> (строка)

Цвет текста кнопки.

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

Содержимое кнопки по умолчанию.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

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

Содержимое кнопки по умолчанию.

ButtonAction -> (строка)

Действие, вызываемое кнопкой.

Link -> (строка)

Назначение кнопки.

CreationDate -> (строка)

Дата создания шаблона.

CustomConfig -> (карта)

Настраиваемая настройка для отправки клиенту.

ключ -> (строка)

значение -> (строка)

LastModifiedDate -> (строка)

Дата последнего изменения шаблона.

Layout -> (строка)

Макет сообщения.

tags -> (карта)

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

ключ -> (строка)

значение -> (строка)

TemplateDescription -> (строка)

Описание шаблона.

TemplateName -> (строка)

Имя шаблона.

TemplateType -> (строка)

Тип шаблона.

Version -> (строка)

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

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

Spec-Zone.ru

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