Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

Удалить маршрут

Описание

Удаляет маршрут из приложения.

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

Синтаксис

  delete-journey
--application-id <value>
--journey-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.

--journey-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
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определенный профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию данного инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

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

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

Вывод

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

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

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

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

Если вы не укажете значение для этого свойства, 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 -> (строка)

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

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

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

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

NextActivity -> (строка)

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

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

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

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

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

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

Branches -> (список)

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

(структура)

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

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

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

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

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

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

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

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

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

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

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

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, в течение которого Amazon Pinpoint определяет, выполнены ли условия активности, или переместит участников к следующей активности в путешествии.

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

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

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

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

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

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

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

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

ComparisonOperator -> (строка)

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

Value -> (двойное)

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

FilterType -> (строка)

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

SegmentId -> (строка)

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

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

SegmentId -> (строка)

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

State -> (строка)

Текущий статус поэтапного процесса. Возможные значения:

  • ПРОЕКТ - поэтапный процесс разрабатывается и еще не опубликован.
  • АКТИВНЫЙ - поэтапный процесс разработан и опубликован. В зависимости от расписания поэтапного процесса, он может в настоящее время выполняться или запланирован на запуск в более позднее время. Если состояние поэтапного процесса АКТИВНЫЙ, вы не можете добавлять, изменять или удалять действия из него.
  • ЗАВЕРШЕННЫЙ - поэтапный процесс опубликован и завершен. Все участники вступили в поэтапный процесс, и ни один участник не ждет завершения поэтапного процесса или каких-либо действий в нем.
  • ОТМЕНЕННЫЙ - поэтапный процесс остановлен. Если состояние поэтапного процесса ОТМЕНЕННЫЙ, вы не можете добавлять, изменять или удалять действия или настройки сегмента из него.
  • ЗАКРЫТЫЙ - поэтапный процесс опубликован и запущен. Возможно, также истекло запланированное время его завершения или прошло запланированное время начала, а частота обновления не была указана. Если состояние поэтапного процесса ЗАКРЫТЫЙ, вы не можете добавлять участников, а существующие участники не могут впервые войти в поэтапный процесс. Однако любые существующие участники, которые в настоящее время ожидают начала действия, могут продолжить поэтапный процесс.

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

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

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

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

WaitForQuietTime -> (булево)

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

RefreshOnSegmentUpdate -> (булево)

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

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

Настройки канала для поэтапного процесса.

ConnectCampaignArn -> (строка)

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

ConnectCampaignExecutionRoleArn -> (строка)

IAM роль ARN, которая должна быть принята при вызове API выполнения кампании Connect для набора звонков.

SendingSchedule -> (булево)

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

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

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

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

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

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

День недели, когда правило будет применено. Допустимые значения: [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

День недели, когда правило будет применено. Допустимые значения: [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

День недели, когда правило будет применено. Допустимые значения: [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

День недели, когда правило будет применено. Допустимые значения: [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

День недели, когда правило будет применено. Допустимые значения: [ПОНЕДЕЛЬНИК, ВТОРНИК, СРЕДА, ЧЕТВЕРГ, ПЯТНИЦА, СУББОТА, ВОСКРЕСЕНЬЕ]

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

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

(структура)

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

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 -> (список)

Правила для канала Голосовая связь.

(структура)

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

Name -> (строка)

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

StartDateTime -> (строка)

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

EndDateTime -> (строка)

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

CUSTOM -> (список)

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

(структура)

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

Name -> (строка)

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

StartDateTime -> (строка)

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

EndDateTime -> (строка)

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

TimezoneEstimationMethods -> (список)

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

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

Примечание

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

(строка)

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

Spec-Zone.ru

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