Spec-Zone.ru › AWS CLI v2

[ aws . pinpoint ]

обновить-состояние-путешествия

Описание

Отменяет (останавливает) активное путешествие.

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

Синтаксис

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

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

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

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

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

Изменяет статус путешествия.

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

Статус путешествия. В настоящее время поддерживаются значения ACTIVE, PAUSED и CANCELLED

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

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

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

Сокращенный синтаксис:

State=string

Синтаксис JSON:

{
  "State": "DRAFT"|"ACTIVE"|"COMPLETED"|"CANCELLED"|"CLOSED"|"PAUSED"
}

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

Переопределить адрес по умолчанию команды указанным адресом.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с сервисами AWS. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI будет выполнять только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команды.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображение версии этого инструмента.

--color (строка)

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

  • on
  • off
  • auto

--no-sign-request (булево)

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

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

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

--cli-connect-timeout (целое число)

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

--cli-binary-format (строка)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строкой base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, соответствующего двоичному блоку, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить кли-пагинатор для вывода.

--cli-auto-prompt (булево)

Автоматически запросить параметры ввода 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 -> (строка)

Уникальный идентификатор версии шаблона сообщения для использования в сообщении. Если указано, это значение должно соответствовать идентификатору существующей версии шаблона. Для получения списка версий и идентификаторов версий шаблона используйте ресурс 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. В случае кампаний это также может быть настраиваемое событие, специфичное для вашего приложения. Для получения информации о стандартных событиях обратитесь к документации Streaming Amazon Pinpoint Events в руководстве разработчика Amazon Pinpoint.

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

Metrics -> (карта)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

Value -> (double)

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

MessageActivity -> (строка)

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

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

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

SegmentId -> (строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

АктивностьПриНевыполнении -> (строка)

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

АктивностьПриВыполнении -> (строка)

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

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

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

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

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

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

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

FromAddress -> (строка)

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

NextActivity -> (строка)

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

TemplateName -> (строка)

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

TemplateVersion -> (строка)

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

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

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

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

NextActivity -> (строка)

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

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

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

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

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

Настройки активности многовариантного разделения. Этот тип активности направляет участников по одному из множества путей (включая путь по умолчанию 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-уведомления, которую нужно использовать для сообщения. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс Template Versions.

Если вы не укажете значение для этого свойства, 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-сообщения, которую нужно использовать для сообщения. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс Template Versions.

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

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

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

NextActivity -> (строка)

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

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

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

WaitFor -> (строка)

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

WaitUntil -> (строка)

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

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

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

NextActivity -> (строка)

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

ApplicationId -> (строка)

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

CreationDate -> (строка)

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

Id -> (строка)

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

LastModifiedDate -> (строка)

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

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

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

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

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

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

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

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

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

EndpointReentryInterval -> (строка)

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

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

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

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

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

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

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

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

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

LocalTime -> (булево)

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

Name -> (строка)

Имя этапа.

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

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

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

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

End -> (строка)

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

Start -> (строка)

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

RefreshFrequency -> (строка)

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

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

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

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

Запланированное время (в формате ISO 8601), когда этап закончился или закончится.

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

Запланированное время (в формате ISO 8601), когда этап начался или начнется.

Timezone -> (строка)

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

StartActivity -> (строка)

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

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

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

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

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

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

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

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

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

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

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

Атрибуты -> (отображение)

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

ИдентификаторСегмента -> (строка)

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

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

ИдентификаторСегмента -> (строка)

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

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

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

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

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

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

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

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

WaitForQuietTime -> (булево)

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

RefreshOnSegmentUpdate -> (булево)

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

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

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

ConnectCampaignArn -> (строка)

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

ConnectCampaignExecutionRoleArn -> (строка)

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

SendingSchedule -> (булево)

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

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

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

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

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

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

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

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

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

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

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

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

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

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

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

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

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

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

(структура)

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

StartTime -> (строка)

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

EndTime -> (строка)

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

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

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

EMAIL -> (список)

Правила для канала 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 -> (список)

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

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

Примечание

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

(строка)

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

Spec-Zone.ru

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