получить-шаблон-push
Описание
Получает содержимое и настройки шаблона сообщения для сообщений, отправляемых через канал push-уведомлений.
См. также: Документация AWS API
Синтаксис
get-push-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 (строка)
--template-version (строка)
Уникальный идентификатор версии шаблона сообщения для обновления, получения информации или удаления. Чтобы получить идентификаторы и другую информацию обо всех версиях шаблона, используйте ресурс «Версии шаблонов».
Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Если указано для операции обновления, это значение должно соответствовать идентификатору последней существующей версии шаблона. Это ограничение помогает предотвратить возникновение проблем с гонками.
Если вы не укажете значение для этого параметра, Amazon Pinpoint выполнит следующие действия:
- Для операции get получает информацию об активной версии шаблона.
- Для операции обновления сохраняет обновления в (заменяет) последнюю существующую версию шаблона, если параметр 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.
Вывод
PushNotificationTemplateResponse -> (структура)
Предоставляет информацию о содержимом и настройках шаблона сообщения, который может быть использован в сообщениях, отправляемых через канал уведомлений.
ADM -> (структура)
Шаблон сообщения, используемый для канала ADM (Amazon Device Messaging). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое должно произойти, если получатель нажмет на уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или становится приложением на переднем плане, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Это действие использует функции глубокой ссылки платформы Android.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
ImageIconUrl -> (строка)
ImageUrl -> (строка)
RawContent -> (строка)
SmallImageIconUrl -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
APNS -> (структура)
Шаблон сообщения, используемый для канала APNS (Apple Push Notification service). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое должно произойти, если получатель нажмёт на уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или становится приложением на переднем плане, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Эта настройка использует возможности глубокой ссылки платформы iOS.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
MediaUrl -> (строка)
RawContent -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
Arn -> (строка)
Baidu -> (структура)
Шаблон сообщения, используемый для канала Baidu (Baidu Cloud Push). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое должно произойти, если получатель нажмёт на уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или становится приложением на переднем плане, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Это действие использует функции глубокой ссылки платформы Android.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
ImageIconUrl -> (строка)
ImageUrl -> (строка)
RawContent -> (строка)
SmallImageIconUrl -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
CreationDate -> (строка)
Default -> (структура)
Шаблон сообщения по умолчанию, используемый для каналов уведомлений.
Action -> (строка)
Действие, которое должно произойти, если получатель нажмёт на уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или становится приложением на переднем плане, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает определённый пользовательский интерфейс в приложении. Эта настройка использует возможности глубокой ссылки платформ iOS и Android.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
Sound -> (строка)
Звук, который воспроизводится, когда получатель получает уведомление, основанное на шаблоне сообщения. Вы можете использовать стандартный поток или указать имя файла ресурса звука, включённого в ваше приложение. На платформе Android файл звука должен находиться в каталоге /res/raw/.
Для платформы iOS это значение — ключ к имени файла звука в основном пакете вашего приложения или папке Library/Sounds в контейнере данных вашего приложения. Если файл звука не найден или вы указали значение по умолчанию, система воспроизводит стандартный звуковой сигнал.
Title -> (строка)
Url -> (строка)
DefaultSubstitutions -> (строка)
GCM -> (структура)
Шаблон сообщения, используемый для канала GCM, который используется для отправки уведомлений через службу Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов push-уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое должно произойти, если получатель нажмет на push-уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или становится фоновым приложением, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает определенный пользовательский интерфейс в приложении. Это действие использует функции глубокой ссылки платформы Android.
- URL - Предпочитаемый мобильный браузер устройства получателя открывает и загружает веб-страницу по указанному вами URL-адресу.
Body -> (строка)
ImageIconUrl -> (строка)
ImageUrl -> (строка)
RawContent -> (строка)
SmallImageIconUrl -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
LastModifiedDate -> (строка)
RecommenderId -> (строка)
tags -> (карта)
Мапа строка-строка пар ключ-значение, которая идентифицирует теги, связанные с шаблоном сообщения. Каждый тег состоит из обязательного ключа тега и соответствующего значения тега.
key -> (строка)
value -> (строка)
TemplateDescription -> (строка)
TemplateName -> (строка)
TemplateType -> (строка)
Version -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.