get-journey
Описание
Получает информацию о состоянии, конфигурации и других настройках этапа.
См. также: AWS API документацию
Синтаксис
get-journey
--application-id <value>
--journey-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--application-id (строка)
--journey-id (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения перепишут значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя предоставленное значение JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит JSON-пример входных данных, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример YAML входных данных, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверит входные данные команды и вернёт JSON-пример выходных данных для этой команды. Сгенерированный JSON-скелет нестабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.
Глобальные параметры
--debug (логическое значение)
Включает отладочную запись в журнал.
--endpoint-url (строка)
Переопределяет значение URL по умолчанию команды указанным URL.
--no-verify-ssl (логическое значение)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого соединения SSL AWS CLI проверит сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (логическое значение)
Отключает автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- text
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использование определённого профиля из вашего файла с данными.
--region (строка)
Используемый регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отображение версии этого инструмента.
--color (строка)
Включение/отключение цветного вывода.
- on
- off
- auto
--no-sign-request (логическое значение)
Не подписывать запросы. Кредиты не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде закодированной строки base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, fileb:// всегда будет обрабатываться как двоичное значение и использовать содержимое файла непосредственно независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного параметра cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое значение)
Отключение кли-пейджера для вывода.
--cli-auto-prompt (логическое значение)
Автоматически запрашивать входные параметры 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 -> (строка)
NextActivity -> (строка)
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 -> (строка)
Values -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериям.
(строка)
Metrics -> (карта)
Один или несколько пользовательских метрик, которые ваше приложение отправляет Amazon Pinpoint. Вы можете использовать эти метрики в качестве критериев выбора при создании фильтра событий.
key -> (строка)
value -> (структура)
Определяет критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии основаны на пользовательских метриках, которые вы определяете для конечных точек.
ComparisonOperator -> (строка)
Value -> (double)
MessageActivity -> (строка)
SegmentCondition -> (структура)
Сегмент, связанный с этапом.
SegmentId -> (строка)
SegmentDimensions -> (структура)
Настройки размеров сегмента, связанного с активностью.
Атрибуты -> (отображение)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
ТипАтрибута -> (строка)
Тип сегмента для измерения. Допустимые значения:
- ВКЛЮЧАЮЩИЙ - конечные точки с совпадающими атрибутами и значениями включаются в сегмент.
- ИСКЛЮЧАЮЩИЙ - конечные точки с совпадающими атрибутами и значениями исключаются из сегмента.
- СОДЕРЖИТ - конечные точки с совпадающими подстроками атрибутов и значений включаются в сегмент.
- ДО - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
- ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, последующие значению, включаются в сегмент.
- В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, совпадающие со значением (время игнорируется в сравнении), включаются в сегмент.
- МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, попадающие в диапазон между значениями, включаются в сегмент.
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
Поведение -> (структура)
Критерии, основанные на поведении, такие как недавнее использование приложения пользователями, для сегмента.
Недавность -> (структура)
Настройки измерения, основанные на недавней активности конечной точки.
Продолжительность -> (строка)
ТипНедавности -> (строка)
Демография -> (структура)
Критерии, основанные на демографии, такие как платформа устройства, для сегмента.
ВерсияПриложения -> (структура)
Критерии версии приложения для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Канал -> (структура)
Критерии канала для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
ТипУстройства -> (структура)
Критерии типа устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Производитель -> (структура)
Критерии производителя устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Модель -> (структура)
Критерии модели устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Платформа -> (структура)
Критерии платформы устройства для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Местоположение -> (структура)
Критерии местоположения, такие как регион или GPS-координаты, для сегмента.
Страна -> (структура)
Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипИзмерения, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
GPSТочка -> (структура)
GPS-местоположение и радиус для сегмента.
Координаты -> (структура)
GPS-координаты для измерения расстояния.
Широта -> (двойное)
Долгота -> (двойное)
ДиапазонВКилометрах -> (двойное)
Метрики -> (отображение)
Один или несколько пользовательских метрик, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии основаны на пользовательских метриках, которые вы определяете для конечных точек.
ОператорСравнения -> (строка)
Значение -> (двойное)
АтрибутыПользователя -> (отображение)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
ТипАтрибута -> (строка)
Тип сегмента для измерения. Допустимые значения:
- ВКЛЮЧАЮЩИЙ - конечные точки с совпадающими атрибутами и значениями включаются в сегмент.
- ИСКЛЮЧАЮЩИЙ - конечные точки с совпадающими атрибутами и значениями исключаются из сегмента.
- СОДЕРЖИТ - конечные точки с совпадающими подстроками атрибутов и значений включаются в сегмент.
- ДО - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
- ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, последующие значению, включаются в сегмент.
- В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, совпадающие со значением (время игнорируется в сравнении), включаются в сегмент.
- МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, попадающие в диапазон между значениями, включаются в сегмент.
Значения -> (список)
Значения критериев для измерения сегмента. В зависимости от свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
Оператор -> (строка)
ВремяОжиданияОценки -> (структура)
Время ожидания, прежде чем определить, выполнены ли условия, или дата и время, когда Amazon Pinpoint определяет, выполнены ли условия.
Подождать -> (строка)
Дождаться -> (строка)
ЛожнаяАктивность -> (строка)
ИстинноеДеятельность -> (строка)
Описание -> (строка)
EMAIL -> (структура)
Настройки действия электронной почты. Этот тип действия отправляет электронное сообщение участникам.
MessageConfig -> (структура)
Указывает адрес отправителя для электронного сообщения, отправляемого участникам в рамках пути.
FromAddress -> (строка)
NextActivity -> (строка)
TemplateName -> (строка)
TemplateVersion -> (строка)
Уникальный идентификатор версии шаблона электронного сообщения, который следует использовать для сообщения. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий шаблона, используйте ресурс Template Versions.
Если вы не укажете значение для этого свойства, Amazon Pinpoint использует активную версию шаблона. Активная версия — это, как правило, версия шаблона, которая была последней просмотрена и одобрена для использования в зависимости от вашего рабочего процесса. Она не обязательно является последней версией шаблона.
Holdout -> (структура)
Настройки действия отбора. Этот тип действия останавливает путь для определенного процента участников.
NextActivity -> (строка)
Percentage -> (целое число)
Процент участников, которые не должны продолжать путь.
Для определения участников, которые отбираются, Amazon Pinpoint применяет алгоритм, основанный на вероятности, к указанному проценту. Поэтому фактический процент отбираемых участников может не совпадать с указанным вами процентом.
MultiCondition -> (структура)
Настройки действия множественного разделения. Этот тип действия направляет участников по одному из нескольких путей (включая путь по умолчанию Else) в пути в зависимости от заданных вами условий.
Branches -> (список)
Пути для действия, включая условия для входа в каждый путь и действие, которое следует выполнить для каждого пути.
(структура)
Указывает условие для оценки пути действия в пути.
Condition -> (структура)
Условие для оценки пути действия.
EventCondition -> (структура)
Настройки измерения для события, связанного с действием.
Dimensions -> (структура)
Измерения для фильтра событий, которые следует использовать для действия.
Attributes -> (карта)
Один или несколько пользовательских атрибутов, которые ваше приложение передает Amazon Pinpoint. Вы можете использовать эти атрибуты в качестве критериев выбора при создании фильтра событий.
key -> (строка)
value -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
AttributeType -> (строка)
Тип измерения сегмента, который следует использовать. Допустимые значения:
- INCLUSIVE — конечные точки с атрибутами, соответствующими значениям, включаются в сегмент.
- EXCLUSIVE — конечные точки с атрибутами, соответствующими значениям, исключаются из сегмента.
- CONTAINS — конечные точки с подстроками атрибутов, соответствующими значениям, включаются в сегмент.
- BEFORE — конечные точки с атрибутами, значения которых в формате ISO_INSTANT являются датами до значения, включаются в сегмент.
- AFTER — конечные точки с атрибутами, значения которых в формате ISO_INSTANT являются датами после значения, включаются в сегмент.
- ON — конечные точки с атрибутами, значения которых в формате ISO_INSTANT являются датами на значение, включаются в сегмент. Время в этом сравнении игнорируется.
- BETWEEN — конечные точки с атрибутами, значения которых в формате ISO_INSTANT являются датами между значениями, включаются в сегмент.
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства AttributeType, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют критериям.
(строка)
EventType -> (структура)
Имя события, которое вызывает отправку кампании или выполнение действия пути. Это может быть стандартное событие, генерируемое Amazon Pinpoint, такое как _email.delivered. Для кампаний это также может быть пользовательское событие, специфичное для вашего приложения. Сведения о стандартных событиях см. в разделе Потоковая передача событий Amazon Pinpoint в руководстве разработчика Amazon Pinpoint.
DimensionType -> (строка)
Values -> (список)
Значения критериев для измерения сегмента. В зависимости от значения свойства DimensionType, конечные точки включаются или исключаются из сегмента, если их значения соответствуют критериям.
(строка)
Metrics -> (карта)
Один или несколько пользовательских метрик, которые ваше приложение передает Amazon Pinpoint. Вы можете использовать эти метрики в качестве критериев выбора при создании фильтра событий.
key -> (строка)
value -> (структура)
Указывает критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии основаны на пользовательских метриках, которые вы определяете для конечных точек.
ComparisonOperator -> (строка)
Value -> (двойное)
MessageActivity -> (строка)
SegmentCondition -> (структура)
Сегмент, связанный с действием.
SegmentId -> (строка)
SegmentDimensions -> (структура)
Настройки размерности для сегмента, связанного с активностью.
Атрибуты -> (отображение)
Один или несколько пользовательских атрибутов, используемых в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
ТипАтрибута -> (строка)
Тип размерности сегмента для использования. Допустимые значения:
- ВКЛЮЧЕНИЕ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
- ИСКЛЮЧЕНИЕ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
- СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
- ДО - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
- ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
- В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT в значении, включаются в сегмент. Время в этом сравнении игнорируется.
- МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
Поведение -> (структура)
Критерии поведения, такие как то, как недавно пользователи использовали ваше приложение, для сегмента.
Недавность -> (структура)
Настройки размерности, основанные на том, как недавно конечная точка была активной.
Продолжительность -> (строка)
ТипНедавности -> (строка)
Демографические данные -> (структура)
Критерии, основанные на демографических данных, такие как платформа устройства, для сегмента.
ВерсияПриложения -> (структура)
Критерии версии приложения для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Канал -> (структура)
Критерии канала для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
ТипУстройства -> (структура)
Критерии типа устройства для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Производитель -> (структура)
Критерии производителя устройства для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Модель -> (структура)
Критерии модели устройства для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Платформа -> (структура)
Критерии платформы устройства для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Расположение -> (структура)
Критерии, основанные на местоположении, такие как регион или координаты GPS, для сегмента.
Страна -> (структура)
Код страны или региона в формате ISO 3166-1 alpha-2 для сегмента.
ТипРазмерности -> (строка)
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипРазмерности, конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
GPSТочка -> (структура)
Местоположение GPS и радиус для сегмента.
Координаты -> (структура)
Координаты GPS для измерения расстояния.
Широта -> (двойное)
Долгота -> (двойное)
ДиапазонВКилометрах -> (двойное)
Метрики -> (отображение)
Один или несколько пользовательских метрик для использования в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии получены из пользовательских метрик, которые вы определяете для конечных точек.
ОператорСравнения -> (строка)
Значение -> (двойное)
АтрибутыПользователя -> (отображение)
Один или несколько пользовательских атрибутов для использования в качестве критериев для сегмента.
ключ -> (строка)
значение -> (структура)
Указывает критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
ТипАтрибута -> (строка)
Тип размерности сегмента для использования. Допустимые значения:
- ВКЛЮЧЕНИЕ - конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
- ИСКЛЮЧЕНИЕ - конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
- СОДЕРЖИТ - конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
- ДО - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT до значения, включаются в сегмент.
- ПОСЛЕ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT после значения, включаются в сегмент.
- В - конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT в значении, включаются в сегмент. Время в этом сравнении игнорируется.
- МЕЖДУ - конечные точки с атрибутами, интерпретируемыми как даты и время ISO_INSTANT между значениями, включаются в сегмент.
Значения -> (список)
Значения критериев для размерности сегмента. В зависимости от значения свойства ТипАтрибута, конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
СледующаяАктивность -> (строка)
АктивностьПоУмолчанию -> (строка)
ВремяОжиданияОценки -> (структура)
Период времени ожидания или дата и время, когда Amazon Pinpoint определяет, соблюдены ли условия.
Ожидать -> (строка)
ОжидатьДо -> (строка)
PUSH -> (структура)
Настройки активности отправки push-уведомлений. Этот тип активности отправляет push-уведомление участникам.
MessageConfig -> (структура)
Указывает значение TTL (Time To Live) для push-уведомлений, отправляемых участникам в рамках путешествия.
TimeToLive -> (строка)
Количество секунд, в течение которых служба push-уведомлений должна хранить сообщение, если служба не смогла доставить уведомление с первого раза. Это значение преобразуется в значение истечения срока действия при отправке в службу push-уведомлений. Если это значение равно 0, служба обрабатывает уведомление так, как если бы оно истекло немедленно, и служба не сохраняет и не пытается повторно доставить уведомление.
Это значение не применяется к сообщениям, отправленным через службу Amazon Device Messaging (ADM).
NextActivity -> (строка)
TemplateName -> (строка)
TemplateVersion -> (строка)
Уникальный идентификатор версии шаблона push-уведомлений, который следует использовать для сообщения. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс «Шаблоны версий».
Если вы не укажете значение для этого свойства, Amazon Pinpoint будет использовать активную версию шаблона. Активная версия обычно является версией шаблона, которая была последней просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.
RandomSplit -> (структура)
Настройки активности случайного разделения. Этот тип активности случайным образом отправляет указанные проценты участников по одному из до пяти путей в путешествии на основе заданных вами условий.
Branches -> (список)
Пути для активности, включая процент участников, которые войдут в каждый путь, и активность, которая должна быть выполнена для каждого пути.
(структура)
Указывает настройки пути в активности случайного разделения в путешествии.
NextActivity -> (строка)
Percentage -> (целое число)
Процент участников, которые должны быть отправлены по пути активности.
Чтобы определить, какие участники отправляются по каждому пути, Amazon Pinpoint применяет алгоритм на основе вероятности к процентам, которые вы указываете для путей. Поэтому фактический процент участников, отправленных по пути, может не совпадать с указанным вами процентом.
SMS -> (структура)
Настройки активности SMS. Этот тип активности отправляет текстовое сообщение участникам.
MessageConfig -> (структура)
Указывает идентификатор отправителя и тип сообщения для SMS-сообщения, отправляемого участникам в рамках путешествия.
MessageType -> (строка)
OriginationNumber -> (строка)
SenderId -> (строка)
EntityId -> (строка)
TemplateId -> (строка)
NextActivity -> (строка)
TemplateName -> (строка)
TemplateVersion -> (строка)
Уникальный идентификатор версии шаблона SMS-сообщения, который следует использовать для сообщения. Если указано, это значение должно совпадать с идентификатором существующей версии шаблона. Чтобы получить список версий и идентификаторов версий для шаблона, используйте ресурс «Шаблоны версий».
Если вы не укажете значение для этого свойства, Amazon Pinpoint будет использовать активную версию шаблона. Активная версия обычно является версией шаблона, которая была последней просмотрена и одобрена для использования, в зависимости от вашего рабочего процесса. Это не обязательно последняя версия шаблона.
Wait -> (структура)
Настройки активности ожидания. Этот тип активности ожидает определенное количество времени или до определенной даты и времени перед перемещением участников к следующей активности в путешествии.
NextActivity -> (строка)
WaitTime -> (структура)
Количество времени для ожидания или дата и время, когда активность перемещает участников к следующей активности в путешествии.
WaitFor -> (строка)
WaitUntil -> (строка)
ContactCenter -> (структура)
Настройки активности подключения к контакт-центру. Этот тип активности инициирует звонок в контакт-центр участникам.
NextActivity -> (строка)
ApplicationId -> (строка)
CreationDate -> (строка)
Id -> (строка)
LastModifiedDate -> (строка)
Limits -> (структура)
Пределы для отправки сообщений и входов для путешествия.
DailyCap -> (целое число)
EndpointReentryCap -> (целое число)
MessagesPerSecond -> (целое число)
EndpointReentryInterval -> (строка)
TimeframeCap -> (структура)
Количество сообщений, которые конечная точка может получить в течение указанного временного интервала.
Cap -> (целое число)
Days -> (целое число)
TotalCap -> (целое число)
LocalTime -> (логическое значение)
Name -> (строка)
QuietTime -> (структура)
Настройки бесшумного времени для путешествия. Бесшумное время — это определенный временной интервал, когда путешествие не отправляет сообщения участникам, если выполнены все следующие условия:
- Свойство EndpointDemographic.Timezone конечной точки для участника установлено на допустимое значение.
- Текущее время в часовом поясе участника позже или равно времени, указанному в свойстве QuietTime.Start для путешествия.
- Текущее время в часовом поясе участника раньше или равно времени, указанному в свойстве QuietTime.End для путешествия.
Если не выполняется ни одно из предыдущих условий, участник получит сообщения от путешествия, даже если бесшумное время включено.
End -> (строка)
Start -> (строка)
RefreshFrequency -> (строка)
Schedule -> (структура)
Настройки расписания для путешествия.
EndTime -> (временная метка)
StartTime -> (временная метка)
Timezone -> (строка)
StartActivity -> (строка)
StartCondition -> (структура)
Сегмент, определяющий, какие пользователи участвуют в путешествии.
Описание -> (строка)
EventStartCondition -> (структура)
Определяет настройки события, которое запускает активность путешествия.
EventFilter -> (структура)
Определяет настройки события, которое вызывает отправку кампании или выполнение активности путешествия.
Dimensions -> (структура)
Размеры для использования фильтра событий для кампании или активности путешествия.
Attributes -> (карта)
Один или несколько пользовательских атрибутов, которые ваше приложение сообщает Amazon Pinpoint. Вы можете использовать эти атрибуты в качестве критериев выбора при создании фильтра событий.
ключ -> (строка)
значение -> (структура)
Определяет критерии, основанные на атрибутах, для включения или исключения конечных точек из сегмента.
AttributeType -> (строка)
Тип измерения сегмента для использования. Допустимые значения:
- INCLUSIVE — конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
- EXCLUSIVE — конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
- CONTAINS — конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
- BEFORE — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
- AFTER — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, последующие за значением, включаются в сегмент.
- ON — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, совпадающие со значением, включаются в сегмент. Время при этом сравнении игнорируется.
- BETWEEN — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT, находящиеся между значениями, включаются в сегмент.
Values -> (список)
Значения критериев для использования в измерении сегмента. В зависимости от значения свойства AttributeType конечные точки включаются или исключаются из сегмента, если их значения атрибутов соответствуют значениям критериев.
(строка)
EventType -> (структура)
Название события, которое вызывает отправку кампании или выполнение активности путешествия. Это может быть стандартное событие, генерируемое Amazon Pinpoint, такое как _email.delivered. Для кампаний это также может быть пользовательское событие, специфичное для вашего приложения. Сведения о стандартных событиях см. в разделе Потоковая передача событий Amazon Pinpoint в руководстве разработчика Amazon Pinpoint.
DimensionType -> (строка)
Values -> (список)
Значения критериев для использования в измерении сегмента. В зависимости от значения свойства DimensionType конечные точки включаются или исключаются из сегмента, если их значения соответствуют значениям критериев.
(строка)
Metrics -> (карта)
Один или несколько пользовательских метрик, которые ваше приложение сообщает Amazon Pinpoint. Вы можете использовать эти метрики в качестве критериев выбора при создании фильтра событий.
ключ -> (строка)
значение -> (структура)
Определяет критерии, основанные на метриках, для включения или исключения конечных точек из сегмента. Эти критерии основаны на пользовательских метриках, которые вы определяете для конечных точек.
ComparisonOperator -> (строка)
Value -> (двойное)
FilterType -> (строка)
SegmentId -> (строка)
SegmentStartCondition -> (структура)
Сегмент, связанный с первой активностью в путешествии. Этот сегмент определяет, какие пользователи участвуют в путешествии.
SegmentId -> (строка)
State -> (строка)
Текущий статус путешествия. Возможные значения:
- DRAFT — путешествие разрабатывается и еще не опубликовано.
- ACTIVE — путешествие разработано и опубликовано. В зависимости от расписания путешествия, оно может в настоящее время выполняться или запланировано на запуск в более позднее время. Если статус путешествия ACTIVE, вы не можете добавлять, изменять или удалять активности из него.
- COMPLETED — путешествие опубликовано и завершено. Все участники прошли через путешествие, и ни один участник не ждет завершения путешествия или каких-либо активностей в путешествии.
- CANCELLED — путешествие остановлено. Если статус путешествия CANCELLED, вы не можете добавлять, изменять или удалять активности или настройки сегмента в путешествии.
- CLOSED — путешествие опубликовано и начало выполняться. Оно также может превысить запланированное время окончания или превысить запланированное время начала, если частота обновления не была указана. Если статус путешествия CLOSED, вы не можете добавлять участников в него, и никакие существующие участники не могут войти в путешествие впервые. Однако любые существующие участники, которые в настоящее время ждут начала активности, могут продолжить путешествие.
tags -> (карта)
Этот объект не используется и не поддерживается.
ключ -> (строка)
значение -> (строка)
WaitForQuietTime -> (булево)
RefreshOnSegmentUpdate -> (булево)
JourneyChannelSettings -> (структура)
Настройки канала для путешествия.
ConnectCampaignArn -> (строка)
ConnectCampaignExecutionRoleArn -> (строка)
SendingSchedule -> (булево)
OpenHours -> (структура)
Время, когда путешествие может отправлять сообщения. QuietTime должен быть настроен в первую очередь, а SendingSchedule должен быть установлен в значение true.
EMAIL -> (карта)
Определяет настройки расписания для канала электронной почты.
ключ -> (строка)
значение -> (список)
Правила открытого часа.
(структура)
Подробности правила открытого часа.
StartTime -> (строка)
EndTime -> (строка)
SMS -> (карта)
Определяет настройки расписания для канала SMS.
ключ -> (строка)
значение -> (список)
Правила открытого часа.
(структура)
Подробности правила открытого часа.
StartTime -> (строка)
EndTime -> (строка)
PUSH -> (карта)
Определяет настройки расписания для канала PUSH.
ключ -> (строка)
значение -> (список)
Правила открытого часа.
(структура)
Подробности правила открытого часа.
StartTime -> (строка)
EndTime -> (строка)
VOICE -> (карта)
Определяет настройки расписания для канала голосовой связи.
ключ -> (строка)
значение -> (список)
Правила открытого часа.
(структура)
Подробности правила открытого часа.
StartTime -> (строка)
EndTime -> (строка)
CUSTOM -> (карта)
Определяет настройки расписания для пользовательского канала.
ключ -> (строка)
значение -> (список)
Правила открытого часа.
(структура)
Подробности правила открытого часа.
StartTime -> (строка)
EndTime -> (строка)
ClosedDays -> (структура)
Время, когда путешествие не будет отправлять сообщения. QuietTime должен быть настроен в первую очередь, а SendingSchedule должен быть установлен в значение true.
EMAIL -> (список)
Правила для канала Email.
(структура)
Подробности правила ClosedDays.
Name -> (строка)
StartDateTime -> (строка)
EndDateTime -> (строка)
SMS -> (список)
Правила для канала SMS.
(структура)
Подробности правила ClosedDays.
Name -> (строка)
StartDateTime -> (строка)
EndDateTime -> (строка)
PUSH -> (список)
Правила для канала Push.
(структура)
Подробности правила ClosedDays.
Name -> (строка)
StartDateTime -> (строка)
EndDateTime -> (строка)
VOICE -> (список)
Правила для канала Voice.
(структура)
Подробности правила ClosedDays.
Name -> (строка)
StartDateTime -> (строка)
EndDateTime -> (строка)
CUSTOM -> (список)
Правила для канала Custom.
(структура)
Подробности правила ClosedDays.
Name -> (строка)
StartDateTime -> (строка)
EndDateTime -> (строка)
TimezoneEstimationMethods -> (список)
Массив методов оценки часового пояса, если таковые имеются, используемых для определения часового пояса конечной точки, если конечная точка не имеет значения для атрибута 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.