обновить-путь

Описание

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

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

Синтаксис

  update-journey
--application-id <value>
--journey-id <value>
--write-journey-request <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 (строка)

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

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

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

--write-journey-request (структура)

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

Activities -> (карта)

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

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

Сравниваемое значение.

MessageActivity -> (строка)

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

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

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

SegmentId -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

ВКЛЮЧАЮЩИЙ - конечные точки, имеющие атрибуты, соответствующие значениям, включаются в сегмент.
ИСКЛЮЧАЮЩИЙ - конечные точки, имеющие атрибуты, соответствующие значениям, исключаются из сегмента.
СОДЕРЖИТ - конечные точки, имеющие подстроки атрибутов, соответствующие значениям, включаются в сегмент.
ДО - конечные точки с атрибутами, читаемыми как даты и время 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, прежде чем определить, были ли выполнены условия действия или участники переместились к следующему действию на этапе этапа.

WaitUntil -> (строка)

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

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

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

NextActivity -> (строка)

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

CreationDate -> (строка)

Дата в формате ISO 8601, когда этап был создан.

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

Название этапа. Название этапа может содержать не более 150 символов. Символы могут быть буквенно-цифровыми или символами, такими как подчеркивания (_) или дефисы (-). В имени этапа не может быть пробелов.

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

Уникальный идентификатор первого действия на этапе. Идентификатор этого действия может содержать не более 128 символов. Символы должны быть буквенно-цифровыми.

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

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

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

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

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

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

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

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

Размеры -> (структура)

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

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

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

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

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

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

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

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

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

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

(строка)

ТипСобытия -> (структура)

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

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

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

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

(строка)

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

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

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

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

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

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

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

ТипФильтра -> (строка)

Тип события, вызывающего отправку кампании или выполнение действия путешествия. Допустимые значения: СИСТЕМНАЯ, отправляет кампанию или выполняет действие, когда происходит системное событие; и КОНЕЧНАЯ_ТОЧКА, отправляет кампанию или выполняет действие, когда происходит событие конечной точки (ресурс событий).

IdСегмента -> (строка)

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

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

IdСегмента -> (строка)

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

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

Статус путешествия. Допустимые значения:

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

Состояния ПРИОСТАНОВЛЕН, ОТМЕНЕН, ЗАВЕРШЕН и ЗАКРЫТ не поддерживаются в запросах на создание или обновление путешествия. Чтобы отменить, приостановить или возобновить путешествие, используйте ресурс Journey Stateresource.

WaitForQuietTime -> (булево)

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

RefreshOnSegmentUpdate -> (булево)

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

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

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

ConnectCampaignArn -> (строка)

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

ConnectCampaignExecutionRoleArn -> (строка)

ARN роли IAM для использования при вызове 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.

Имя -> (строка)

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

StartDateTime -> (строка)

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

EndDateTime -> (строка)

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

SMS -> (список)

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

(структура)

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

Имя -> (строка)

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

StartDateTime -> (строка)

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

EndDateTime -> (строка)

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

PUSH -> (список)

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

(структура)

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

Имя -> (строка)

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

StartDateTime -> (строка)

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

EndDateTime -> (строка)

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

VOICE -> (список)

Правила для голосового канала.

(структура)

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

Имя -> (строка)

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

StartDateTime -> (строка)

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

EndDateTime -> (строка)

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

CUSTOM -> (список)

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

(структура)

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

Имя -> (строка)

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

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.

(строка)

Синтаксис JSON:

{
  "Activities": {"string": {
        "CUSTOM": {
          "DeliveryUri": "string",
          "EndpointTypes": ["PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|"IN_APP", ...],
          "MessageConfig": {
            "Data": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "ConditionalSplit": {
          "Condition": {
            "Conditions": [
              {
                "EventCondition": {
                  "Dimensions": {
                    "Attributes": {"string": {
                          "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                          "Values": ["string", ...]
                        }
                      ...},
                    "EventType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Metrics": {"string": {
                          "ComparisonOperator": "string",
                          "Value": double
                        }
                      ...}
                  },
                  "MessageActivity": "string"
                },
                "SegmentCondition": {
                  "SegmentId": "string"
                },
                "SegmentDimensions": {
                  "Attributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...},
                  "Behavior": {
                    "Recency": {
                      "Duration": "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
                      "RecencyType": "ACTIVE"|"INACTIVE"
                    }
                  },
                  "Demographic": {
                    "AppVersion": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Channel": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "DeviceType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Make": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Model": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Platform": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    }
                  },
                  "Location": {
                    "Country": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "GPSPoint": {
                      "Coordinates": {
                        "Latitude": double,
                        "Longitude": double
                      },
                      "RangeInKilometers": double
                    }
                  },
                  "Metrics": {"string": {
                        "ComparisonOperator": "string",
                        "Value": double
                      }
                    ...},
                  "UserAttributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...}
                }
              }
              ...
            ],
            "Operator": "ALL"|"ANY"
          },
          "EvaluationWaitTime": {
            "WaitFor": "string",
            "WaitUntil": "string"
          },
          "FalseActivity": "string",
          "TrueActivity": "string"
        },
        "Description": "string",
        "EMAIL": {
          "MessageConfig": {
            "FromAddress": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "Holdout": {
          "NextActivity": "string",
          "Percentage": integer
        },
        "MultiCondition": {
          "Branches": [
            {
              "Condition": {
                "EventCondition": {
                  "Dimensions": {
                    "Attributes": {"string": {
                          "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                          "Values": ["string", ...]
                        }
                      ...},
                    "EventType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Metrics": {"string": {
                          "ComparisonOperator": "string",
                          "Value": double
                        }
                      ...}
                  },
                  "MessageActivity": "string"
                },
                "SegmentCondition": {
                  "SegmentId": "string"
                },
                "SegmentDimensions": {
                  "Attributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...},
                  "Behavior": {
                    "Recency": {
                      "Duration": "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
                      "RecencyType": "ACTIVE"|"INACTIVE"
                    }
                  },
                  "Demographic": {
                    "AppVersion": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Channel": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "DeviceType": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Make": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Model": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "Platform": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    }
                  },
                  "Location": {
                    "Country": {
                      "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                      "Values": ["string", ...]
                    },
                    "GPSPoint": {
                      "Coordinates": {
                        "Latitude": double,
                        "Longitude": double
                      },
                      "RangeInKilometers": double
                    }
                  },
                  "Metrics": {"string": {
                        "ComparisonOperator": "string",
                        "Value": double
                      }
                    ...},
                  "UserAttributes": {"string": {
                        "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                        "Values": ["string", ...]
                      }
                    ...}
                }
              },
              "NextActivity": "string"
            }
            ...
          ],
          "DefaultActivity": "string",
          "EvaluationWaitTime": {
            "WaitFor": "string",
            "WaitUntil": "string"
          }
        },
        "PUSH": {
          "MessageConfig": {
            "TimeToLive": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "RandomSplit": {
          "Branches": [
            {
              "NextActivity": "string",
              "Percentage": integer
            }
            ...
          ]
        },
        "SMS": {
          "MessageConfig": {
            "MessageType": "TRANSACTIONAL"|"PROMOTIONAL",
            "OriginationNumber": "string",
            "SenderId": "string",
            "EntityId": "string",
            "TemplateId": "string"
          },
          "NextActivity": "string",
          "TemplateName": "string",
          "TemplateVersion": "string"
        },
        "Wait": {
          "NextActivity": "string",
          "WaitTime": {
            "WaitFor": "string",
            "WaitUntil": "string"
          }
        },
        "ContactCenter": {
          "NextActivity": "string"
        }
      }
    ...},
  "CreationDate": "string",
  "LastModifiedDate": "string",
  "Limits": {
    "DailyCap": integer,
    "EndpointReentryCap": integer,
    "MessagesPerSecond": integer,
    "EndpointReentryInterval": "string",
    "TimeframeCap": {
      "Cap": integer,
      "Days": integer
    },
    "TotalCap": integer
  },
  "LocalTime": true|false,
  "Name": "string",
  "QuietTime": {
    "End": "string",
    "Start": "string"
  },
  "RefreshFrequency": "string",
  "Schedule": {
    "EndTime": timestamp,
    "StartTime": timestamp,
    "Timezone": "string"
  },
  "StartActivity": "string",
  "StartCondition": {
    "Description": "string",
    "EventStartCondition": {
      "EventFilter": {
        "Dimensions": {
          "Attributes": {"string": {
                "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                "Values": ["string", ...]
              }
            ...},
          "EventType": {
            "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
            "Values": ["string", ...]
          },
          "Metrics": {"string": {
                "ComparisonOperator": "string",
                "Value": double
              }
            ...}
        },
        "FilterType": "SYSTEM"|"ENDPOINT"
      },
      "SegmentId": "string"
    },
    "SegmentStartCondition": {
      "SegmentId": "string"
    }
  },
  "State": "DRAFT"|"ACTIVE"|"COMPLETED"|"CANCELLED"|"CLOSED"|"PAUSED",
  "WaitForQuietTime": true|false,
  "RefreshOnSegmentUpdate": true|false,
  "JourneyChannelSettings": {
    "ConnectCampaignArn": "string",
    "ConnectCampaignExecutionRoleArn": "string"
  },
  "SendingSchedule": true|false,
  "OpenHours": {
    "EMAIL": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "SMS": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "PUSH": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "VOICE": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...},
    "CUSTOM": {"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|"SUNDAY": [
          {
            "StartTime": "string",
            "EndTime": "string"
          }
          ...
        ]
      ...}
  },
  "ClosedDays": {
    "EMAIL": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "SMS": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "PUSH": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "VOICE": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ],
    "CUSTOM": [
      {
        "Name": "string",
        "StartDateTime": "string",
        "EndDateTime": "string"
      }
      ...
    ]
  },
  "TimezoneEstimationMethods": ["PHONE_NUMBER"|"POSTAL_CODE", ...]
}

--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 для вывода.

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

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

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

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

Вывод

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

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

Настройки активности разделения «да/нет». Этот тип активности направляет участников по одному из двух путей на этапе, основываясь на условиях, которые вы указываете.

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

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

Conditions -> (список)

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

(структура)

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

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, попадающие в диапазон между значениями, включаются в сегмент.

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

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

(строка)

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

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

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

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

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

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

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

Тип размерности недавности для сегмента. Допустимые значения: ACTIVE (активные конечные точки в течение указанной продолжительности включаются в сегмент) и INACTIVE (неактивные конечные точки в течение указанной продолжительности исключаются из сегмента).

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

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

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

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

(строка)

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

Критерии, основанные на местоположении, такие как регион или 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 -> (структура)

Настройки действия «Мультивариативное разделение». Этот тип действия направляет участников по одному из возможных пяти путей (включая путь по умолчанию «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, прежде чем Amazon Pinpoint определит, выполнены ли условия активности или переместит участников к следующей активности в маршруте.

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

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

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

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

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

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

TimeToLive -> (строка)

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

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

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

Branches -> (список)

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

(структура)

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

NextActivity -> (строка)

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

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

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

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

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

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

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

MessageType -> (строка)

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

OriginationNumber -> (строка)

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

SenderId -> (строка)

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

EntityId -> (строка)

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

TemplateId -> (строка)

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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.

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (карта)

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

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

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

ComparisonOperator -> (строка)

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

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

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

FilterType -> (строка)

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

SegmentId -> (строка)

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

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

SegmentId -> (строка)

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

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

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

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

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

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

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

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

WaitForQuietTime -> (булево)

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

RefreshOnSegmentUpdate -> (булево)

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

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

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

ConnectCampaignArn -> (строка)

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

ConnectCampaignExecutionRoleArn -> (строка)

IAM роль ARN, которая должна быть принята при вызове 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 -> (список)

Правила для канала 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.

(строка)