обновить-шаблон-в-приложении
Описание
Обновляет существующий шаблон сообщения для сообщений, отправленных через канал сообщений в приложении.
См. также: Документацию API AWS
Синтаксис
update-in-app-template
[--create-new-version | --no-create-new-version]
--in-app-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 (boolean)
Указывает, следует ли сохранять обновления в качестве новой версии шаблона сообщений. Допустимые значения: true — сохранить обновления как новую версию; false — сохранить обновления в (перезаписать) последнюю существующую версию шаблона.
Если вы не укажете значение для этого параметра, Amazon Pinpoint сохранит обновления в (перезапишет) последнюю существующую версию шаблона. Если вы укажете значение true для этого параметра, не указывайте значение для параметра version. В противном случае произойдёт ошибка.
--in-app-template-request (структура)
Запрос шаблона InApp.
Content -> (список)
Содержание сообщения, может содержать до 5 модальных окон. Каждое модальное окно должно содержать сообщение, заголовок и цвет фона. ImageUrl и кнопки являются необязательными.
(структура)
Настройка содержимого сообщения.
BackgroundColor -> (строка)
BodyConfig -> (структура)
Настройка тела сообщения.
Alignment -> (строка)
Body -> (строка)
TextColor -> (строка)
HeaderConfig -> (структура)
Настройка заголовка сообщения.
Alignment -> (строка)
Header -> (строка)
TextColor -> (строка)
ImageUrl -> (строка)
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 -> (строка)
CustomConfig -> (карта)
Настройка для отправки клиенту.
key -> (строка)
value -> (строка)
Layout -> (строка)
tags -> (карта)
Примечание
Начиная с 22-05-2023, параметры тегов устарели для операций обновления. После этой даты любые значения в тегах не обрабатываются, и код ошибки не возвращается. Для управления тегами рекомендуется использовать либо Теги в Справочнике по API Amazon Pinpoint, команды resourcegroupstaggingapi в Документации AWS CLI или resourcegroupstaggingapi в AWS SDK.(Устарело) Строка-строковая карта пар ключ-значение, определяющих теги, которые необходимо назначить шаблону сообщения. Каждый тег состоит из требуемого ключа тега и соответствующего значения тега.
key -> (строка)
value -> (строка)
TemplateDescription -> (строка)
Синтаксис JSON:
{
"Content": [
{
"BackgroundColor": "string",
"BodyConfig": {
"Alignment": "LEFT"|"CENTER"|"RIGHT",
"Body": "string",
"TextColor": "string"
},
"HeaderConfig": {
"Alignment": "LEFT"|"CENTER"|"RIGHT",
"Header": "string",
"TextColor": "string"
},
"ImageUrl": "string",
"PrimaryBtn": {
"Android": {
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string"
},
"DefaultConfig": {
"BackgroundColor": "string",
"BorderRadius": integer,
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string",
"Text": "string",
"TextColor": "string"
},
"IOS": {
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string"
},
"Web": {
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string"
}
},
"SecondaryBtn": {
"Android": {
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string"
},
"DefaultConfig": {
"BackgroundColor": "string",
"BorderRadius": integer,
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string",
"Text": "string",
"TextColor": "string"
},
"IOS": {
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string"
},
"Web": {
"ButtonAction": "LINK"|"DEEP_LINK"|"CLOSE",
"Link": "string"
}
}
}
...
],
"CustomConfig": {"string": "string"
...},
"Layout": "BOTTOM_BANNER"|"TOP_BANNER"|"OVERLAYS"|"MOBILE_FEED"|"MIDDLE_BANNER"|"CAROUSEL",
"tags": {"string": "string"
...},
"TemplateDescription": "string"
}
--template-name (строка)
--template-version (строка)
Уникальный идентификатор версии шаблона сообщения для обновления, получения информации или удаления. Чтобы получить идентификаторы и другую информацию обо всех версиях шаблона, используйте ресурс Template Versions.
Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Если указано для операции обновления, это значение должно соответствовать идентификатору последней существующей версии шаблона. Это ограничение помогает избежать возникновения проблем гонки.
Если вы не укажете значение для этого параметра, 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 (boolean)
Включить отладочную регистрацию.
--endpoint-url (строка)
Переопределяет значение URL по умолчанию для команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определённый профиль из файла ваших учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--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 (boolean)
Отключить пагинатор cli для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода CLI.
Вывод
MessageBody -> (структура)
Предоставляет информацию об API-запросе или ответе.
Message -> (строка)
RequestID -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.