Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

get-in-app-messages

Описание

Получает сообщения, предназначенные для указанного идентификатора конечной точки.

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

Синтаксис

  get-in-app-messages
--application-id <value>
--endpoint-id <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]

Параметры

--application-id (строка)

Уникальный идентификатор приложения. Этот идентификатор отображается как Идентификатор проекта в консоли Amazon Pinpoint.

--endpoint-id (строка)

Уникальный идентификатор конечной точки.

--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
  • text
  • таблица
  • 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 (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

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

Объект ответа на запрос о внутриприложениевых сообщениях.

InAppMessageCampaigns -> (список)

Список целевых кампаний внутриприложениевых сообщений.

(структура)

Целевая кампания внутриприложениевого сообщения.

CampaignId -> (строка)

Идентификатор кампании.

DailyCap -> (целое число)

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

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

Содержание внутриприложениевого сообщения со всеми полями, необходимыми для отображения.

Content -> (список)

Содержание внутриприложениевого сообщения.

(структура)

Настройка содержимого сообщения.

BackgroundColor -> (строка)

Цвет фона сообщения.

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

Настройка тела сообщения.

Alignment -> (строка)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Body -> (строка)

Тело сообщения.

TextColor -> (строка)

Цвет текста.

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

Настройка заголовка сообщения.

Alignment -> (строка)

Выравнивание текста. Допустимые значения: LEFT, CENTER, RIGHT.

Header -> (строка)

Заголовок сообщения.

TextColor -> (строка)

Цвет текста.

ImageUrl -> (строка)

URL изображения для фона сообщения.

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 -> (карта)

Дополнительные настройки для отправки в SDK.

key -> (строка)

value -> (строка)

Layout -> (строка)

Макет сообщения.

Priority -> (целое число)

Приоритет внутриприложениевого сообщения.

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

Расписание кампании.

EndDate -> (строка)

Время, после которого внутриприложениевое сообщение не должно отображаться. Время указано в формате ISO 8601.

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

Фильтр событий, используемый SDK для отображения внутриприложениевого сообщения в приложении.

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

Настройки размерности фильтра событий для кампании.

Attributes -> (карта)

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

key -> (строка)

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

Указывает критерии отбора на основе атрибутов для включения или исключения конечных точек из сегмента.

AttributeType -> (строка)

Тип размерности сегмента для использования. Допустимые значения:

  • INCLUSIVE - конечные точки с совпадающими атрибутами включаются в сегмент.
  • EXCLUSIVE - конечные точки с совпадающими атрибутами исключаются из сегмента.
  • CONTAINS - конечные точки с атрибутами, содержащими заданные значения, включаются в сегмент.
  • BEFORE - конечные точки с атрибутами, значения которых являются датами ISO_INSTANT, предшествующими значению, включаются в сегмент.
  • AFTER - конечные точки с атрибутами, значения которых являются датами ISO_INSTANT, последующими за значением, включаются в сегмент.
  • ON - конечные точки с атрибутами, значения которых являются датами ISO_INSTANT в заданную дату, включаются в сегмент. Время при этом игнорируется.
  • BETWEEN - конечные точки с атрибутами, значения которых являются датами ISO_INSTANT между указанными значениями, включаются в сегмент.

Values -> (список)

Значения критериев для размерности сегмента. В зависимости от значения свойства AttributeType, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.

(строка)

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

Имя события, вызывающего отправку кампании или выполнение действия в переходе. Это может быть стандартное событие, генерируемое Amazon Pinpoint, например, _email.delivered. Для кампаний это также может быть пользовательское событие, специфичное для вашего приложения. Сведения о стандартных событиях см. в разделе Потоковая передача событий Amazon Pinpoint в руководстве разработчика Amazon Pinpoint.

DimensionType -> (строка)

Тип размерности сегмента для использования. Допустимые значения: INCLUSIVE (конечные точки, соответствующие критериям, включаются в сегмент); и EXCLUSIVE (конечные точки, соответствующие критериям, исключаются из сегмента).

Values -> (список)

Значения критериев для размерности сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.

(строка)

Metrics -> (карта)

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

key -> (строка)

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

Указывает критерии отбора на основе метрик для включения или исключения конечных точек из сегмента. Эти критерии основаны на пользовательских метриках, которые вы определяете для конечных точек.

ComparisonOperator -> (строка)

Оператор, используемый при сравнении значений метрик. Допустимые значения: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL и EQUAL.

Value -> (вещественное число)

Значение для сравнения.

FilterType -> (строка)

Тип события, вызывающего отправку кампании. Допустимые значения: SYSTEM (отправляет кампанию при возникновении системного события); и ENDPOINT (отправляет кампанию при возникновении события конечной точки).

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

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

End -> (строка)

Точное время окончания режима «Тишина». Значение должно быть в 24-часовом формате и иметь формат ЧЧ:ММ, где ЧЧ — час (с ведущим нулём, если требуется), а ММ — минуты. Например, используйте 02:30 для обозначения 2:30 утра или 14:30 для обозначения 2:30 дня.

Start -> (строка)

Точное время начала режима «Тишина». Значение должно быть в 24-часовом формате и иметь формат ЧЧ:ММ, где ЧЧ — час (с ведущим нулём, если требуется), а ММ — минуты. Например, используйте 02:30 для обозначения 2:30 утра или 14:30 для обозначения 2:30 дня.

SessionCap -> (целое число)

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

TotalCap -> (целое число)

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

TreatmentId -> (строка)

Идентификатор варианта кампании.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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