создание-шаблона-внутриприложения
Описание
Создает новый шаблон сообщения для сообщений, использующих канал сообщений в приложении.
См. также: Документацию AWS API
Синтаксис
create-in-app-template
--in-app-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]
Параметры
--in-app-template-request (структура)
Запрос шаблона сообщения в приложении.
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 Command Line Interface или 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 (строка)
--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.
Вывод
TemplateCreateMessageBody -> (структура)
Предоставляет информацию о запросе на создание шаблона сообщения.
Arn -> (строка)
Message -> (строка)
RequestID -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.