Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

list-journeys

Описание

Получает информацию о статусе, настройках и других параметрах всех маршрутов, связанных с приложением.

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

Синтаксис

  list-journeys
--application-id <value>
[--page-size <value>]
[--token <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.

--page-size (строка)

Максимальное количество элементов на странице в случае пагинации. Этот параметр не поддерживается для метрик приложений, кампаний и маршрутов.

--token (строка)

Строка NextToken, определяющая, какую страницу результатов вернуть в случае пагинации.

--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.

Вывод

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

Предоставляет информацию о статусе, конфигурации и других параметрах всех путешествий, связанных с приложением.

Item -> (список)

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

(структура)

Предоставляет информацию о статусе, конфигурации и других параметрах путешествия.

Activities -> (карта)

Карта, содержащая набор объектов Activity, по одному для каждой активности в путешествии. Для каждого объекта Activity ключ представляет собой уникальный идентификатор (строка) активности, а значение — настройки активности.

key -> (строка)

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

Определяет конфигурацию и другие параметры активности в путешествии.

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

Настройки активности пользовательского сообщения. Этот тип активности вызывает функцию AWS Lambda или веб-хук, который отправляет сообщения участникам.

DeliveryUri -> (строка)

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

  • Имя или Amazon Resource Name (ARN) функции AWS Lambda, которую нужно вызвать для обработки доставки кампании или лечения.
  • URL веб-приложения или службы, поддерживающей HTTPS и способной получать сообщение. URL должен быть полным URL-адресом, включая протокол HTTPS.

EndpointTypes -> (список)

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

(строка)

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

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

Data -> (строка)

Содержание сообщения, передаваемое функции AWS Lambda или веб-хуку.

NextActivity -> (строка)

Уникальный идентификатор следующей активности, которую необходимо выполнить после того, как Amazon Pinpoint вызовет функцию AWS Lambda или веб-хук.

TemplateName -> (строка)

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

TemplateVersion -> (строка)

Уникальный идентификатор версии шаблона сообщения, который нужно использовать для сообщения. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия обычно представляет собой версию шаблона, которая была недавно просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Она не обязательно является последней версией шаблона.

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

Настройки активности разделения по условиям. Этот тип активности направляет участников по одному из двух путей в путешествии на основе заданных условий.

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

Условие, определяющее пути для активности и отношения между условиями.

Conditions -> (список)

Условия для проверки активности.

(структура)

Определяет условие для проверки активности в путешествии.

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

Параметры измерения события, связанного с активностью.

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 -> (double)

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

MessageActivity -> (строка)

Идентификатор сообщения (message_id) для использования при определении соответствия событий сообщений условию.

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

Сегмент, связанный с активностью.

SegmentId -> (строка)

Уникальный идентификатор сегмента, который нужно связать с активностью.

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

Настройки размеров сегмента, связанного с активностью.

Атрибуты -> (карта)

Один или несколько пользовательских атрибутов для использования в качестве критериев сегмента.

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

  • ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
  • ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
  • СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
  • ДО - конечные точки с атрибутами, считаемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
  • ПОСЛЕ - конечные точки с атрибутами, считаемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
  • В - конечные точки с атрибутами, считаемыми как даты ISO_INSTANT в значение, включаются в сегмент. Время при этом сравнении игнорируется.
  • МЕЖДУ - конечные точки с атрибутами, считаемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют критериальным значениям.

(строка)

Поведение -> (структура)

Критерии поведения, такие как недавнее использование приложения пользователями, для сегмента.

Недавность -> (структура)

Настройки размерности, основанные на том, как недавно конечная точка была активна.

Продолжительность -> (строка)

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

ТипНедавности -> (строка)

Тип размерности недавности для сегмента. Допустимые значения: АКТИВНО, конечные точки, которые были активны в течение указанной продолжительности, включаются в сегмент; и НЕАКТИВНО, конечные точки, которые не были активны в течение указанной продолжительности, исключаются из сегмента.

Демографические данные -> (структура)

Критерии демографических данных, такие как платформа устройства, для сегмента.

ВерсияПриложения -> (структура)

Критерии версии приложения для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

Канал -> (структура)

Критерии канала для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

ТипУстройства -> (структура)

Критерии типа устройства для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

Местоположение -> (структура)

Критерии местоположения, такие как регион или GPS-координаты, для сегмента.

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

ТипРазмерности -> (строка)

Тип размерности сегмента для использования. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериальным значениям.

(строка)

GPSТочка -> (структура)

GPS-местоположение и радиус для сегмента.

Координаты -> (структура)

GPS-координаты для измерения расстояния.

Широта -> (двойное)

Координата широты местоположения.

Долгота -> (двойное)

Координата долготы местоположения.

ДиапазонВКилометрах -> (двойное)

Диапазон в километрах от GPS-координат.

Метрики -> (карта)

Один или несколько пользовательских метрик для использования в качестве критериев сегмента.

ключ -> (строка)

значение -> (структура)

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

ОператорСравнения -> (строка)

Оператор для сравнения значений метрик. Допустимые значения: БОЛЬШЕ, МЕНЬШЕ, БОЛЬШЕ_ИЛИ_РАВНО, МЕНЬШЕ_ИЛИ_РАВНО и РАВНО.

Значение -> (двойное)

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

АтрибутыПользователей -> (карта)

Один или несколько пользовательских атрибутов пользователя для использования в качестве критериев сегмента.

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

  • ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
  • ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
  • СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
  • ДО - конечные точки с атрибутами, считаемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
  • ПОСЛЕ - конечные точки с атрибутами, считаемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
  • В - конечные точки с атрибутами, считаемыми как даты ISO_INSTANT в значение, включаются в сегмент. Время при этом сравнении игнорируется.
  • МЕЖДУ - конечные точки с атрибутами, считаемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.

Значения -> (список)

Критериальные значения для размерности сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют критериальным значениям.

(строка)

Оператор -> (строка)

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

ВремяОжиданияВычисления -> (структура)

Время ожидания, прежде чем определить, выполнены ли условия, или дата и время, когда Amazon Pinpoint определяет, выполнены ли условия.

Ожидать -> (строка)

Время ожидания в формате ISO 8601 в виде продолжительности, прежде чем определить, выполнены ли условия активности или перевести участников на следующую активность в маршруте.

ОжидатьДо -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности или активность переводит участников на следующую активность в маршруте.

ЛожнаяАктивность -> (строка)

Уникальный идентификатор активности, которая должна выполняться, если условия не выполнены.

ИстиннаяАктивность -> (строка)

Уникальный идентификатор активности, которая должна выполняться, если условия выполнены.

Описание -> (строка)

Пользовательское описание активности.

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

Настройки действия с электронной почтой. Этот тип действия отправляет электронное сообщение участникам.

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

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

FromAddress -> (строка)

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

NextActivity -> (строка)

Уникальный идентификатор следующего действия, которое выполняется после отправки сообщения.

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия, как правило, является версией шаблона, которая была недавно проверена и одобрена для использования в зависимости от вашего рабочего процесса. Она не обязательно является последней версией шаблона.

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

Настройки действия «отбор». Этот тип действия приостанавливает маршрут для определенного процента участников.

NextActivity -> (строка)

Уникальный идентификатор следующего действия, которое выполняется после выполнения действия «отбор».

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

Процент участников, которые не должны продолжать маршрут.

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

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

Настройки действия «многовариантный сплит». Этот тип действия направляет участников по одному из пяти путей (включая путь по умолчанию «Else») в маршруте на основе заданных вами условий.

Branches -> (список)

Пути действия, включая условия перехода на каждый путь и действие, которое выполняется для каждого пути.

(структура)

Указывает условие для проверки на пути действия в маршруте.

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

Условие для проверки на пути действия.

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

Настройки измерения события, связанного с действием.

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 -> (двойное значение)

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

MessageActivity -> (строка)

Идентификатор сообщения (message_id) для использования при определении того, соответствуют ли события сообщений условию.

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

Сегмент, связанный с действием.

SegmentId -> (строка)

Уникальный идентификатор сегмента, который следует связать с действием.

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

Настройки размеров сегмента, связанного с активностью.

Атрибуты -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

  • ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
  • ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
  • СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
  • ДО - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
  • ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
  • В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT в значение, включаются в сегмент. Время при этом сравнении игнорируется.
  • МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

Поведение -> (структура)

Критерии, основанные на поведении, например, как недавно пользователи использовали ваше приложение, для сегмента.

Новизна -> (структура)

Настройки измерений, основанные на том, как недавно конечная точка была активна.

Длительность -> (строка)

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

ТипНовизны -> (строка)

Тип измерения новизны для сегмента. Допустимые значения: АКТИВНО, конечные точки, которые были активны в течение указанной длительности, включаются в сегмент; и НЕАКТИВНО, конечные точки, которые не были активны в течение указанной длительности, исключаются из сегмента.

Демографические данные -> (структура)

Критерии, основанные на демографических данных, например, платформа устройства, для сегмента.

ВерсияПриложения -> (структура)

Критерии версии приложения для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Канал -> (структура)

Критерии канала для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

ТипУстройства -> (структура)

Критерии типа устройства для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Производитель -> (структура)

Критерии производителя устройства для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Модель -> (структура)

Критерии модели устройства для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Платформа -> (структура)

Критерии платформы устройства для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

Расположение -> (структура)

Критерии, основанные на местоположении, например, регион или координаты GPS, для сегмента.

Страна -> (структура)

Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.

ТипИзмерения -> (строка)

Тип сегментного измерения, используемого. Допустимые значения: ВКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, включаются в сегмент; и ИСКЛЮЧАЮЩИЙ, конечные точки, соответствующие критериям, исключаются из сегмента.

Значения -> (список)

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

(строка)

GPSТочка -> (структура)

Местоположение GPS и радиус для сегмента.

Координаты -> (структура)

Координаты GPS для измерения расстояния.

Широта -> (двойное)

Координата широты местоположения.

Долгота -> (двойное)

Координата долготы местоположения.

ДиапазонВКилометрах -> (двойное)

Диапазон в километрах от координат GPS.

Метрики -> (карта)

Один или несколько пользовательских метрик, используемых в качестве критериев для сегмента.

ключ -> (строка)

значение -> (структура)

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

ОператорСравнения -> (строка)

Оператор, используемый при сравнении значений метрик. Допустимые значения: БОЛЬШЕ, МЕНЬШЕ, БОЛЬШЕ_ИЛИ_РАВНО, МЕНЬШЕ_ИЛИ_РАВНО и РАВНО.

Значение -> (двойное)

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

АтрибутыПользователя -> (карта)

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

ключ -> (строка)

значение -> (структура)

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

ТипАтрибута -> (строка)

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

  • ВКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
  • ИСКЛЮЧАЮЩИЙ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
  • СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
  • ДО - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
  • ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
  • В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT в значение, включаются в сегмент. Время при этом сравнении игнорируется.
  • МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.

Значения -> (список)

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

(строка)

СледующаяАктивность -> (строка)

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

АктивностьПоУмолчанию -> (строка)

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

ВремяОжиданияОценки -> (структура)

Время ожидания или дата и время, когда Amazon Pinpoint определяет, соблюдены ли условия.

Ожидать -> (строка)

Время ожидания в формате ISO 8601, прежде чем определить, выполнены ли условия активности или участники переведены на следующую активность в маршруте.

Дождаться -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности или активность переводит участников на следующую активность в маршруте.

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

Настройки активности отправки push-уведомлений. Этот тип активности отправляет push-уведомление участникам.

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

Указывает значение времени жизни (TTL) для push-уведомлений, отправляемых участникам в рамках этапа.

TimeToLive -> (строка)

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

Это значение не относится к сообщениям, отправляемым через службу Amazon Device Messaging (ADM).

NextActivity -> (строка)

Уникальный идентификатор следующей активности, выполняемой после отправки сообщения.

TemplateName -> (строка)

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

TemplateVersion -> (строка)

Уникальный идентификатор версии шаблона push-уведомления для использования в сообщении. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс «Шаблоны версий».

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

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

Настройки активности случайного разделения. Этот тип активности случайным образом отправляет указанные проценты участников по одному из пяти путей в этапе, в зависимости от указанных вами условий.

Branches -> (список)

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

(структура)

Указывает настройки пути в активности случайного разделения в этапе.

NextActivity -> (строка)

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

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

Процент участников, которые должны перейти на путь активности.

Для определения участников, направляемых на каждый путь, Amazon Pinpoint применяет алгоритм, основанный на вероятности, к процентам, которые вы указываете для путей. Поэтому фактический процент участников, отправленных по пути, может не совпадать с указанным вами процентом.

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

Настройки активности SMS. Этот тип активности отправляет текстовое сообщение участникам.

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

Указывает идентификатор отправителя и тип сообщения для SMS-сообщения, отправляемого участникам в рамках этапа.

MessageType -> (строка)

Тип SMS-сообщения. Допустимые значения: TRANSACTIONAL (для критически важных или срочных сообщений, таких как одноразовые пароли) и PROMOTIONAL (для сообщений, не являющихся критическими или срочными, например, маркетинговые сообщения).

OriginationNumber -> (строка)

Длинный код для отправки SMS-сообщения. Это значение должно быть одним из выделенных длинных кодов, назначенных вашей учетной записи AWS. Хотя это не обязательно, рекомендуется указывать длинный код в формате E.164, чтобы обеспечить своевременную и точную доставку сообщения. Например, +12065550100.

SenderId -> (строка)

Идентификатор отправителя, отображаемый как отправитель сообщения на устройстве получателя. Поддержка идентификаторов отправителей варьируется в зависимости от страны или региона. Более подробную информацию см. в руководстве пользователя Amazon Pinpoint в разделе Поддерживаемые страны и регионы.

EntityId -> (строка)

Идентификатор сущности или идентификатор основной сущности (PE), полученный от регулирующего органа для отправки SMS в вашей стране.

TemplateId -> (строка)

Идентификатор шаблона, полученный от регулирующего органа для отправки SMS в вашей стране.

NextActivity -> (строка)

Уникальный идентификатор следующей активности для выполнения после отправки сообщения.

TemplateName -> (строка)

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

TemplateVersion -> (строка)

Уникальный идентификатор версии шаблона SMS для использования в сообщении. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс «Шаблоны версий».

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

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

Настройки активности ожидания. Этот тип активности ожидает определенное количество времени или до определенной даты и времени перед переходом участников к следующей активности на этапе.

NextActivity -> (строка)

Уникальный идентификатор следующей активности для выполнения после выполнения активности ожидания.

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

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

WaitFor -> (строка)

Время ожидания в формате ISO 8601, до достижения условий активности или перехода участников к следующей активности на этапе.

WaitUntil -> (строка)

Дата и время в формате ISO 8601, когда Amazon Pinpoint определяет, выполнены ли условия активности, или активность переводит участников к следующей активности на этапе.

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

Настройки активности соединения. Этот тип активности инициирует звонок в контактный центр для участников.

NextActivity -> (строка)

Уникальный идентификатор следующей активности для выполнения после этой активности.

ApplicationId -> (строка)

Уникальный идентификатор приложения, к которому относится этап.

CreationDate -> (строка)

Дата создания этапа в формате ISO 8601.

Id -> (строка)

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

LastModifiedDate -> (строка)

Дата последнего изменения этапа в формате ISO 8601.

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

Пределы отправки сообщений и входа для этапа.

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

Максимальное количество сообщений, которые этап может отправить одному участнику в течение 24 часов. Максимальное значение 100.

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

Максимальное количество раз, которое участник может войти в этап. Максимальное значение 100. Чтобы разрешить участникам неограниченное количество входов в этап, установите это значение в 0.

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

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

EndpointReentryInterval -> (строка)

Минимальное время, которое должно пройти, прежде чем конечная точка сможет повторно войти в данный этап. Длительность должна быть в формате ISO 8601, например PT1H.

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

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

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

Максимальное количество сообщений, которые все этапы могут отправить конечной точке в течение указанного интервала. Максимальное значение 100. Если установлено в 0, это ограничение не будет применяться.

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

Продолжительность временного интервала в днях. Максимальное значение 30. Если установлено в 0, это ограничение не будет применяться.

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

Максимальное количество сообщений, которые этап может отправить одной конечной точке. Максимальное значение 100. Если установлено в 0, это ограничение не будет применяться.

LocalTime -> (булево)

Указывает, используются ли запланированные время начала и окончания этапа по местному времени каждого участника. Если это значение true, расписание использует местное время каждого участника.

Name -> (строка)

Название этапа.

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

Настройки тихой зоны для этапа. Тихая зона — это определенный временной интервал, в котором этап не отправляет сообщения участникам, если выполнены все следующие условия:

  • Свойство EndpointDemographic.Timezone конечной точки участника установлено в корректное значение.
  • Текущее время в часовом поясе участника позже или равно времени, указанному в свойстве QuietTime.Start этапа.
  • Текущее время в часовом поясе участника раньше или равно времени, указанному в свойстве QuietTime.End для этапа.

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

End -> (строка)

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

Start -> (строка)

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

RefreshFrequency -> (строка)

Частота, с которой Amazon Pinpoint оценивает данные сегмента и события для этапа, в формате ISO 8601.

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

Настройки расписания этапа.

EndTime -> (временная метка)

Запланированное время окончания этапа в формате ISO 8601.

StartTime -> (временная метка)

Запланированное время начала этапа в формате ISO 8601.

Timezone -> (строка)

Начальная смещение от UTC для расписания этапа, если значение свойства LocalTime этапа равно true. Допустимые значения: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02, UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-09:30, UTC-10, и UTC-11.

StartActivity -> (строка)

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

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

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

Описание -> (строка)

Пользовательское описание условия.

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

Указывает настройки события, вызывающего запуск активности путешествия.

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

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

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

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

Attributes -> (отображение)

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

ключ -> (строка)

значение -> (структура)

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

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. Вы можете использовать эти метрики в качестве критериев выбора при создании фильтра событий.

ключ -> (строка)

значение -> (структура)

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

ComparisonOperator -> (строка)

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

Значение -> (двойное)

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

FilterType -> (строка)

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

SegmentId -> (строка)

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

Сегмент, связанный с первой активностью в путешествии. Этот сегмент определяет, какие пользователи участвуют в путешествии.

SegmentId -> (строка)

Уникальный идентификатор сегмента, который нужно связать с активностью.

State -> (строка)

Текущий статус путешествия. Возможные значения:

  • DRAFT - путешествие разрабатывается и еще не опубликовано.
  • ACTIVE - путешествие разработано и опубликовано. В зависимости от графика путешествие может в настоящее время выполняться или запланировано на более позднее время. Если статус путешествия ACTIVE, вы не можете добавлять, изменять или удалять активности.
  • COMPLETED - путешествие опубликовано и выполнено. Все участники прошли путешествие, и ни один участник не ожидает завершения путешествия или каких-либо активностей в путешествии.
  • CANCELLED - путешествие остановлено. Если статус путешествия CANCELLED, вы не можете добавлять, изменять или удалять активности или настройки сегмента в путешествии.
  • CLOSED - путешествие опубликовано и начато. Оно также может истечь по запланированной дате окончания или истечь по запланированной дате начала, если не задана частота обновления. Если статус путешествия CLOSED, вы не можете добавлять участников, и существующие участники не могут впервые войти в путешествие. Однако существующие участники, которые в настоящее время ожидают начала активности, могут продолжить путешествие.

tags -> (отображение)

Этот объект не используется и не поддерживается.

ключ -> (строка)

значение -> (строка)

WaitForQuietTime -> (булево)

Указывает, должны ли конечные точки в часы тишины входить в активность ожидания до истечения часов тишины.

RefreshOnSegmentUpdate -> (булево)

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

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

Настройки канала для путешествия.

ConnectCampaignArn -> (строка)

Amazon Resource Name (ARN) кампании Connect.

ConnectCampaignExecutionRoleArn -> (строка)

ARN роли IAM для использования при вызове API выполнения кампании Connect для совершения звонков.

SendingSchedule -> (булево)

Указывает, разрешено ли использование расширенного времени тишины в путешествии. Этот флаг следует установить в значение true, чтобы можно было использовать OpenHours и ClosedDays.

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

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

EMAIL -> (отображение)

Указывает настройки расписания для канала электронной почты.

ключ -> (строка)

День недели, когда будет применено правило. Допустимые значения: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

значение -> (список)

Правила открытых часов.

(структура)

Подробности правила открытых часов.

StartTime -> (строка)

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

EndTime -> (строка)

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

SMS -> (отображение)

Указывает настройки расписания для SMS-канала.

ключ -> (строка)

День недели, когда будет применено правило. Допустимые значения: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

значение -> (список)

Правила открытых часов.

(структура)

Подробности правила открытых часов.

StartTime -> (строка)

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

EndTime -> (строка)

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

PUSH -> (отображение)

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

ключ -> (строка)

День недели, когда будет применено правило. Допустимые значения: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

значение -> (список)

Правила открытых часов.

(структура)

Подробности правила открытых часов.

StartTime -> (строка)

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

EndTime -> (строка)

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

VOICE -> (отображение)

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

ключ -> (строка)

День недели, когда будет применено правило. Допустимые значения: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

значение -> (список)

Правила открытых часов.

(структура)

Подробности правила открытых часов.

StartTime -> (строка)

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

EndTime -> (строка)

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

CUSTOM -> (отображение)

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

ключ -> (строка)

День недели, когда будет применено правило. Допустимые значения: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

значение -> (список)

Правила открытых часов.

(структура)

Подробности правила открытых часов.

StartTime -> (строка)

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

EndTime -> (строка)

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

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

Время, когда маршрут не будет отправлять сообщения. QuietTime должен быть сконфигурирован в первую очередь, а SendingSchedule должен быть установлен в значение true.

EMAIL -> (список)

Правила для канала электронной почты.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытого дня.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

SMS -> (список)

Правила для канала SMS.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытого дня.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

PUSH -> (список)

Правила для канала Push.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытого дня.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

VOICE -> (список)

Правила для канала Voice.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытого дня.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

CUSTOM -> (список)

Правила для канала Custom.

(структура)

Подробности правила ClosedDays.

Name -> (строка)

Название правила закрытого дня.

StartDateTime -> (строка)

Дата и время начала в формате ISO 8601

EndDateTime -> (строка)

Дата и время окончания в формате ISO 8601

TimezoneEstimationMethods -> (список)

Массив методов оценки часового пояса, если таковые имеются, для определения часового пояса конечной точки, если у конечной точки нет значения атрибута Demographic.Timezone.

  • PHONE_NUMBER - Часовой пояс определяется на основе Endpoint.Address и Endpoint.Location.Country.
  • POSTAL_CODE - Часовой пояс определяется на основе Endpoint.Location.PostalCode и Endpoint.Location.Country.

Примечание

Обнаружение POSTAL_CODE поддерживается только в США, Великобритании, Австралии, Новой Зеландии, Канаде, Франции, Италии, Испании, Германии и в регионах, где доступен Amazon Pinpoint.

(строка)

NextToken -> (строка)

Строка, используемая в последующем запросе для получения следующей страницы результатов в ответ на пагинацию. Это значение равно null, если дополнительных страниц нет.

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

Spec-Zone.ru

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