create-push-template
Описание
Создаёт шаблон сообщения для сообщений, отправляемых через канал push-уведомлений.
См. также: AWS API документация
Синтаксис
create-push-template
--push-notification-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]
Параметры
--push-notification-template-request (структура)
Определяет содержимое и настройки шаблона сообщения, который можно использовать в сообщениях, отправляемых через канал push-уведомлений.
ADM -> (структура)
Шаблон сообщения для канала ADM (Amazon Device Messaging). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов push-уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое выполняется, если получатель нажимает на push-уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или переходит на передний план, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Это действие использует возможности глубокой ссылки платформы Android.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
ImageIconUrl -> (строка)
ImageUrl -> (строка)
RawContent -> (строка)
SmallImageIconUrl -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
APNS -> (структура)
Шаблон сообщения для канала APNS (Apple Push Notification service). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов push-уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое выполняется, если получатель нажимает на push-уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или переходит на передний план, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Это значение использует возможности глубокой ссылки платформы iOS.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
MediaUrl -> (строка)
RawContent -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
Baidu -> (структура)
Шаблон сообщения для канала Baidu (Baidu Cloud Push). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов push-уведомлений (DefaultPushNotificationTemplate).
Action -> (строка)
Действие, которое выполняется, если получатель нажимает на push-уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или переходит на передний план, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Это действие использует возможности глубокой ссылки платформы Android.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
ImageIconUrl -> (строка)
ImageUrl -> (строка)
RawContent -> (строка)
SmallImageIconUrl -> (строка)
Sound -> (строка)
Title -> (строка)
Url -> (строка)
Default -> (структура)
Шаблон сообщения по умолчанию для каналов push-уведомлений.
Action -> (строка)
Действие, которое выполняется, если получатель нажимает на push-уведомление, основанное на шаблоне сообщения. Допустимые значения:
- OPEN_APP - Ваше приложение открывается или переходит на передний план, если оно было отправлено на задний план. Это действие по умолчанию.
- DEEP_LINK - Ваше приложение открывается и отображает указанный пользовательский интерфейс в приложении. Это значение использует возможности глубокой ссылки платформ iOS и Android.
- URL - Стандартный мобильный браузер на устройстве получателя открывает и загружает веб-страницу по указанному URL.
Body -> (строка)
Sound -> (строка)
Звук, воспроизводимый, когда получатель получает push-уведомление, основанное на шаблоне сообщения. Можно использовать стандартный поток или указать имя файла звука, входящего в состав вашего приложения. На платформе Android файл звука должен находиться в /res/raw/.
Для платформы iOS это значение является ключом для имени файла звука в главном пакете вашего приложения или папке Library/Sounds в контейнере данных вашего приложения. Если файл звука не найден или указано значение default, система воспроизводит стандартный звуковой сигнал.
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 -> (строка)
RecommenderId -> (строка)
tags -> (карта)
Примечание
По состоянию на 22-05-2023, tags устарел для операций обновления. После этой даты любое значение в tags не обрабатывается, и код ошибки не возвращается. Для управления тегами рекомендуется использовать теги в Справочнике по API Amazon Pinpoint, команды resourcegroupstaggingapi в Документации по AWS Command Line Interface или resourcegroupstaggingapi в AWS SDK.(Устаревшее) Карта пар ключ-значение, определяющая теги для сопоставления с шаблоном сообщения. Каждый тег состоит из требуемого ключа тега и связанного с ним значения тега.
key -> (строка)
value -> (строка)
TemplateDescription -> (строка)
Краткая синтаксическая запись:
ADM={Action=string,Body=string,ImageIconUrl=string,ImageUrl=string,RawContent=string,SmallImageIconUrl=string,Sound=string,Title=string,Url=string},APNS={Action=string,Body=string,MediaUrl=string,RawContent=string,Sound=string,Title=string,Url=string},Baidu={Action=string,Body=string,ImageIconUrl=string,ImageUrl=string,RawContent=string,SmallImageIconUrl=string,Sound=string,Title=string,Url=string},Default={Action=string,Body=string,Sound=string,Title=string,Url=string},DefaultSubstitutions=string,GCM={Action=string,Body=string,ImageIconUrl=string,ImageUrl=string,RawContent=string,SmallImageIconUrl=string,Sound=string,Title=string,Url=string},RecommenderId=string,tags={KeyName1=string,KeyName2=string},TemplateDescription=string
Синтаксис JSON:
{
"ADM": {
"Action": "OPEN_APP"|"DEEP_LINK"|"URL",
"Body": "string",
"ImageIconUrl": "string",
"ImageUrl": "string",
"RawContent": "string",
"SmallImageIconUrl": "string",
"Sound": "string",
"Title": "string",
"Url": "string"
},
"APNS": {
"Action": "OPEN_APP"|"DEEP_LINK"|"URL",
"Body": "string",
"MediaUrl": "string",
"RawContent": "string",
"Sound": "string",
"Title": "string",
"Url": "string"
},
"Baidu": {
"Action": "OPEN_APP"|"DEEP_LINK"|"URL",
"Body": "string",
"ImageIconUrl": "string",
"ImageUrl": "string",
"RawContent": "string",
"SmallImageIconUrl": "string",
"Sound": "string",
"Title": "string",
"Url": "string"
},
"Default": {
"Action": "OPEN_APP"|"DEEP_LINK"|"URL",
"Body": "string",
"Sound": "string",
"Title": "string",
"Url": "string"
},
"DefaultSubstitutions": "string",
"GCM": {
"Action": "OPEN_APP"|"DEEP_LINK"|"URL",
"Body": "string",
"ImageIconUrl": "string",
"ImageUrl": "string",
"RawContent": "string",
"SmallImageIconUrl": "string",
"Sound": "string",
"Title": "string",
"Url": "string"
},
"RecommenderId": "string",
"tags": {"string": "string"
...},
"TemplateDescription": "string"
}
--template-name (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, указанному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет воспринята буквально. Это может не быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено значение NULL или значение 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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из вашего файла учетных данных.
--region (строка)
Регион для использования. Переопределяет параметры config/env.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл CA-сертификатов для использования при проверке SSL-сертификатов. Переопределяет параметры config/env.
--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-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросы параметров входных данных CLI.
Вывод
CreateTemplateMessageBody -> (структура)
Предоставляет информацию о запросе на создание шаблона сообщения.
Arn -> (строка)
Message -> (строка)
RequestID -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.