Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

обновить-шаблон-уведомлений

Описание

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

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

Синтаксис

  update-push-template
[--create-new-version | --no-create-new-version]
--push-notification-template-request <value>
--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]

Параметры

--create-new-version | --no-create-new-version (булево)

Указывает, следует ли сохранить обновления в виде новой версии шаблона сообщения. Допустимые значения: true — сохранить обновления как новую версию; false — сохранить обновления (перезаписать) в последней существующей версии шаблона.

Если вы не укажете значение для этого параметра, Amazon Pinpoint сохранит обновления в (перезапишет) последней существующей версии шаблона. Если вы укажете значение true для этого параметра, не указывайте значение для параметра version. В противном случае произойдет ошибка.

--push-notification-template-request (структура)

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

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

Шаблон сообщения для канала ADM (Amazon Device Messaging). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов уведомлений (DefaultPushNotificationTemplate).

Action -> (строка)

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

  • OPEN_APP — ваше приложение откроется или станет активным, если оно было в фоновом режиме. Это действие по умолчанию.
  • DEEP_LINK — ваше приложение откроется и отобразит определённый пользовательский интерфейс в приложении. Это действие использует возможности глубоких ссылок платформы Android.
  • URL — стандартный мобильный браузер на устройстве получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (строка)

Текст сообщения для уведомления, основанного на шаблоне сообщения.

ImageIconUrl -> (строка)

URL большого значка изображения для отображения в представлении содержимого уведомления, основанного на шаблоне сообщения.

ImageUrl -> (строка)

URL изображения для отображения в уведомлении, основанном на шаблоне сообщения.

RawContent -> (строка)

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

SmallImageIconUrl -> (строка)

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

Sound -> (строка)

Звук, который должен воспроизводиться, когда получатель получает уведомление, основанное на шаблоне сообщения. Можно использовать стандартный поток или указать имя файла звука, входящего в пакет вашего приложения. На платформе Android файл звука должен находиться в /res/raw/.

Title -> (строка)

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

Url -> (строка)

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

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

Шаблон сообщения для канала APNS (Apple Push Notification service). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов уведомлений (DefaultPushNotificationTemplate).

Action -> (строка)

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

  • OPEN_APP — ваше приложение откроется или станет активным, если оно было в фоновом режиме. Это действие по умолчанию.
  • DEEP_LINK — ваше приложение откроется и отобразит определённый пользовательский интерфейс в приложении. Это свойство использует возможности глубоких ссылок платформы iOS.
  • URL — стандартный мобильный браузер на устройстве получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (строка)

Текст сообщения для уведомлений, основанных на шаблоне сообщения.

MediaUrl -> (строка)

URL изображения или видео для отображения в уведомлениях, основанных на шаблоне сообщения.

RawContent -> (строка)

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

Sound -> (строка)

Ключ для звука, который должен воспроизводиться, когда получатель получает уведомление, основанное на шаблоне сообщения. Значение этого ключа — имя файла звука в основном пакете вашего приложения или папке Library/Sounds в контейнере данных вашего приложения. Если файл звука не найден или вы указали значение default, система воспроизведёт стандартный звуковой сигнал.

Title -> (строка)

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

Url -> (строка)

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

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

Шаблон сообщения для канала Baidu (Baidu Cloud Push). Этот шаблон сообщения переопределяет шаблон по умолчанию для каналов уведомлений (DefaultPushNotificationTemplate).

Action -> (строка)

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

  • OPEN_APP — ваше приложение откроется или станет активным, если оно было в фоновом режиме. Это действие по умолчанию.
  • DEEP_LINK — ваше приложение откроется и отобразит определённый пользовательский интерфейс в приложении. Это действие использует возможности глубоких ссылок платформы Android.
  • URL — стандартный мобильный браузер на устройстве получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (строка)

Текст сообщения для уведомления, основанного на шаблоне сообщения.

ImageIconUrl -> (строка)

URL большого значка изображения для отображения в представлении содержимого уведомления, основанного на шаблоне сообщения.

ImageUrl -> (строка)

URL изображения для отображения в уведомлении, основанном на шаблоне сообщения.

RawContent -> (строка)

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

SmallImageIconUrl -> (строка)

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

Sound -> (строка)

Звук, который должен воспроизводиться, когда получатель получает уведомление, основанное на шаблоне сообщения. Можно использовать стандартный поток или указать имя файла звука, входящего в пакет вашего приложения. На платформе Android файл звука должен находиться в /res/raw/.

Title -> (строка)

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

Url -> (строка)

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

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

Шаблон сообщения по умолчанию для каналов уведомлений.

Action -> (строка)

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

  • OPEN_APP — ваше приложение откроется или станет активным, если оно было в фоновом режиме. Это действие по умолчанию.
  • DEEP_LINK — ваше приложение откроется и отобразит определённый пользовательский интерфейс в приложении. Это свойство использует возможности глубоких ссылок платформ iOS и Android.
  • URL — стандартный мобильный браузер на устройстве получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (строка)

Текст сообщения для уведомлений, основанных на шаблоне сообщения.

Sound -> (строка)

Звук, который должен воспроизводиться, когда получатель получает уведомление, основанное на шаблоне сообщения. Можно использовать стандартный поток или указать имя файла звука, входящего в пакет вашего приложения. На платформе Android файл звука должен находиться в /res/raw/.

Для платформы iOS это значение является ключом для имени файла звука в основном пакете вашего приложения или папке Library/Sounds в контейнере данных вашего приложения. Если файл звука не найден или вы указали значение default, система воспроизведёт стандартный звуковой сигнал.

Title -> (строка)

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

Url -> (строка)

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

DefaultSubstitutions -> (строка)

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

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

Шаблон сообщения для канала GCM, используемого для отправки уведомлений через Firebase Cloud Messaging (FCM), ранее Google Cloud Messaging (GCM). Этот шаблон сообщения переопределяет стандартный шаблон для каналов push-уведомлений (DefaultPushNotificationTemplate).

Action -> (строка)

Действие, которое должно произойти, если получатель нажмет push-уведомление, основанное на шаблоне сообщения. Допустимые значения:

  • OPEN_APP - Ваше приложение откроется или станет фоновым приложением, если оно было отправлено на задний план. Это действие по умолчанию.
  • DEEP_LINK - Ваше приложение откроется и отобразит указанный пользовательский интерфейс в приложении. Это действие использует возможности глубокой ссылки платформы Android.
  • URL - Стандартный мобильный браузер на устройстве получателя откроет и загрузит веб-страницу по указанному вами URL.

Body -> (строка)

Тело сообщения, используемого в push-уведомлении, основанном на шаблоне сообщения.

ImageIconUrl -> (строка)

URL большого значка изображения для отображения в области содержимого push-уведомления, основанного на шаблоне сообщения.

ImageUrl -> (строка)

URL изображения для отображения в push-уведомлении, основанном на шаблоне сообщения.

RawContent -> (строка)

Необработанная строка в формате JSON, используемая в качестве полезной нагрузки для push-уведомления, основанного на шаблоне сообщения. Если указано, это значение переопределяет всё остальное содержимое шаблона сообщения.

SmallImageIconUrl -> (строка)

URL малого значка изображения для отображения в строке состояния и области содержимого push-уведомления, основанного на шаблоне сообщения.

Sound -> (строка)

Звук, воспроизводимый, когда получатель получает push-уведомление, основанное на шаблоне сообщения. Можно использовать стандартный поток или указать имя файла звукового ресурса, входящего в состав вашего приложения. В Android платформа, файл звука должен находиться в /res/raw/.

Title -> (строка)

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

Url -> (строка)

URL для открытия в стандартном мобильном браузере получателя, если получатель нажимает push-уведомление, основанное на шаблоне сообщения, а значение свойства Action равно URL.

RecommenderId -> (строка)

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

tags -> (карта)

Примечание

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

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

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

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

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

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

Автоматически запрашивать параметры CLI.

--no-cli-auto-prompt (булево)

Отключить автоматический запрос параметров CLI.

Вывод

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

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

Message -> (строка)

Сообщение, возвращаемое от API.

RequestID -> (строка)

Уникальный идентификатор запроса или ответа.

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

Spec-Zone.ru

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