обновить-сегмент

Описание

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

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

Синтаксис

  update-segment
--application-id <value>
--segment-id <value>
--write-segment-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.

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

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

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

Указывает конфигурацию, размер и другие параметры сегмента. Объект WriteSegmentRequest может содержать объект Dimensions или SegmentGroups, но не оба одновременно.

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

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

Attributes -> (массив)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

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

(строка)

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

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

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

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

Duration -> (строка)

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

RecencyType -> (строка)

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

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

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

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

Latitude -> (double)

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

Longitude -> (double)

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

RangeInKilometers -> (double)

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

Metrics -> (массив)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

Value -> (double)

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

UserAttributes -> (массив)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

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

Values -> (список)

(строка)

Name -> (строка)

Название сегмента.

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

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

Groups -> (список)

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

(структура)

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

Dimensions -> (список)

Массив, определяющий размеры для сегмента.

(структура)

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

Attributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

INCLUSIVE — конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
EXCLUSIVE — конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
CONTAINS — конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
BEFORE — конечные точки с атрибутами, считаемыми как ISO_INSTANT временные метки, предшествующие значению, включаются в сегмент.
AFTER — конечные точки с атрибутами, считаемыми как ISO_INSTANT временные метки, последующие значению, включаются в сегмент.
ON — конечные точки с атрибутами, считаемыми как ISO_INSTANT даты на значении, включаются в сегмент. Время в этом сравнении игнорируется.
BETWEEN — конечные точки с атрибутами, считаемыми как ISO_INSTANT временные метки, попадающие между значениями, включаются в сегмент.

Values -> (список)

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

(строка)

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

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

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

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

Duration -> (строка)

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

RecencyType -> (строка)

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

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

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

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

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

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

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

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

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

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

Metrics -> (карта)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

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

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

UserAttributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

INCLUSIVE — конечные точки, у которых атрибуты соответствуют значениям, включаются в сегмент.
EXCLUSIVE — конечные точки, у которых атрибуты соответствуют значениям, исключаются из сегмента.
CONTAINS — конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
BEFORE — конечные точки с атрибутами, считаемыми как ISO_INSTANT временные метки, предшествующие значению, включаются в сегмент.
AFTER — конечные точки с атрибутами, считаемыми как ISO_INSTANT временные метки, последующие значению, включаются в сегмент.
ON — конечные точки с атрибутами, считаемыми как ISO_INSTANT даты на значении, включаются в сегмент. Время в этом сравнении игнорируется.
BETWEEN — конечные точки с атрибутами, считаемыми как ISO_INSTANT временные метки, попадающие между значениями, включаются в сегмент.

Values -> (список)

(строка)

SourceSegments -> (список)

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

Вы можете указать более одного размерного сегмента или только один импортированный сегмент. Если вы указываете импортированный сегмент, консоль Amazon Pinpoint отображает оценку размера сегмента, которая указывает размер импортированного сегмента без применения к нему каких-либо фильтров.

(структура)

Указывает идентификатор сегмента и версию сегмента.

Id -> (строка)

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

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

Номер версии сегмента.

SourceType -> (строка)

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

Type -> (строка)

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

Include -> (строка)

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

tags -> (карта)

Примечание

По состоянию на 22-05-2023 теги устарели для операций обновления. После этой даты любые значения в тегах не обрабатываются, и код ошибки не возвращается. Для управления тегами рекомендуется использовать теги в Справочнике API Amazon Pinpoint, команды resourcegroupstaggingapi в Документации AWS Command Line Interface или resourcegroupstaggingapi в AWS SDK.

(Устарело) Строковая карта пар ключ-значение, которая определяет теги для ассоциации с сегментом. Каждый тег состоит из обязательного ключа тега и связанного значения тега.

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

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

Синтаксис JSON:

{
  "Dimensions": {
    "Attributes": {"string": {
          "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
          "Values": ["string", ...]
        }
      ...},
    "Behavior": {
      "Recency": {
        "Duration": "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
        "RecencyType": "ACTIVE"|"INACTIVE"
      }
    },
    "Demographic": {
      "AppVersion": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      },
      "Channel": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      },
      "DeviceType": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      },
      "Make": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      },
      "Model": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      },
      "Platform": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      }
    },
    "Location": {
      "Country": {
        "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
        "Values": ["string", ...]
      },
      "GPSPoint": {
        "Coordinates": {
          "Latitude": double,
          "Longitude": double
        },
        "RangeInKilometers": double
      }
    },
    "Metrics": {"string": {
          "ComparisonOperator": "string",
          "Value": double
        }
      ...},
    "UserAttributes": {"string": {
          "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
          "Values": ["string", ...]
        }
      ...}
  },
  "Name": "string",
  "SegmentGroups": {
    "Groups": [
      {
        "Dimensions": [
          {
            "Attributes": {"string": {
                  "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                  "Values": ["string", ...]
                }
              ...},
            "Behavior": {
              "Recency": {
                "Duration": "HR_24"|"DAY_7"|"DAY_14"|"DAY_30",
                "RecencyType": "ACTIVE"|"INACTIVE"
              }
            },
            "Demographic": {
              "AppVersion": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              },
              "Channel": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              },
              "DeviceType": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              },
              "Make": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              },
              "Model": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              },
              "Platform": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              }
            },
            "Location": {
              "Country": {
                "DimensionType": "INCLUSIVE"|"EXCLUSIVE",
                "Values": ["string", ...]
              },
              "GPSPoint": {
                "Coordinates": {
                  "Latitude": double,
                  "Longitude": double
                },
                "RangeInKilometers": double
              }
            },
            "Metrics": {"string": {
                  "ComparisonOperator": "string",
                  "Value": double
                }
              ...},
            "UserAttributes": {"string": {
                  "AttributeType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEFORE"|"AFTER"|"ON"|"BETWEEN",
                  "Values": ["string", ...]
                }
              ...}
          }
          ...
        ],
        "SourceSegments": [
          {
            "Id": "string",
            "Version": integer
          }
          ...
        ],
        "SourceType": "ALL"|"ANY"|"NONE",
        "Type": "ALL"|"ANY"|"NONE"
      }
      ...
    ],
    "Include": "ALL"|"ANY"|"NONE"
  },
  "tags": {"string": "string"
    ...}
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной JSON-строки. JSON-строка следует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью предоставленного JSON-значения, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса к API. Если предоставлено без значения или со значением input, выводит пример входного JSON, который может использоваться в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, будет напечатан пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, оно проверяет входные данные команды и возвращает пример выходного JSON для этой команды. Сгенерированный JSON-скелет не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (булево)

Включить отладку регистрации.

--endpoint-url (строка)

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

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

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

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

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

--output (строка)

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

json
text
table
yaml
yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

on
off
auto

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

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

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

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

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

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

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

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

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

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

base64
raw-in-base64-out

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

Отключить страницу cli для вывода.

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

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

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

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

Вывод

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

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

ApplicationId -> (строка)

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

Arn -> (строка)

Amazon Resource Name (ARN) сегмента.

CreationDate -> (строка)

Дата и время создания сегмента.

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

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

Attributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

INCLUSIVE — конечные точки, атрибуты которых соответствуют значениям, включаются в сегмент.
EXCLUSIVE — конечные точки, атрибуты которых соответствуют значениям, исключаются из сегмента.
CONTAINS — конечные точки, атрибуты которых содержат подстроки значений, включаются в сегмент.
BEFORE — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
AFTER — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, последующие значению, включаются в сегмент.
ON — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, соответствующие значению, включаются в сегмент. Время при этом сравнении игнорируется.
BETWEEN — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, попадающие в диапазон значений, включаются в сегмент.

Values -> (список)

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

(строка)

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

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

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

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

Duration -> (строка)

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

RecencyType -> (строка)

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

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

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

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

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

DimensionType -> (строка)

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

Values -> (список)

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

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

Географическое местоположение и радиус для сегмента.

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

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

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

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

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

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

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

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

Metrics -> (карта)

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

key -> (строка)

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

ComparisonOperator -> (строка)

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

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

UserAttributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

INCLUSIVE — конечные точки, атрибуты которых соответствуют значениям, включаются в сегмент.
EXCLUSIVE — конечные точки, атрибуты которых соответствуют значениям, исключаются из сегмента.
CONTAINS — конечные точки, атрибуты которых содержат подстроки значений, включаются в сегмент.
BEFORE — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, предшествующие значению, включаются в сегмент.
AFTER — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, последующие значению, включаются в сегмент.
ON — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, соответствующие значению, включаются в сегмент. Время при этом сравнении игнорируется.
BETWEEN — конечные точки с атрибутами, интерпретируемыми как даты ISO_INSTANT, попадающие в диапазон значений, включаются в сегмент.

Values -> (список)

(строка)

Id -> (строка)

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

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

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

ChannelCounts -> (карта)

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

key -> (строка)

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

ExternalId -> (строка)

(Устаревшее) Ваш идентификатор AWS учетной записи, который вы назначили внешнему идентификатору в политике доверия IAM. Amazon Pinpoint ранее использовал это значение для принятия роли IAM при импорте определений конечных точек, но мы удалили эту необходимость. Не рекомендуется использовать внешние идентификаторы для ролей IAM, которые принимаются Amazon Pinpoint.

Format -> (строка)

Формат файлов, импортированных для создания сегмента. Допустимые значения: CSV (формат с разделителями запятыми) и JSON (формат JSON с разделителями новых строк).

RoleArn -> (строка)

Amazon Resource Name (ARN) роли AWS Identity and Access Management (IAM), которая предоставила Amazon Pinpoint доступ к расположению Amazon S3 для импорта определений конечных точек.

S3Url -> (строка)

URL ведра Amazon Simple Storage Service (Amazon S3), из которого были импортированы определения конечных точек для создания сегмента.

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

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

LastModifiedDate -> (строка)

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

Name -> (строка)

Название сегмента.

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

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

Groups -> (список)

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

(структура)

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

Dimensions -> (список)

Массив, определяющий измерения для сегмента.

(структура)

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

Attributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

INCLUSIVE — конечные точки с атрибутами, соответствующими значениям, включаются в сегмент.
EXCLUSIVE — конечные точки с атрибутами, соответствующими значениям, исключаются из сегмента.
CONTAINS — конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
BEFORE — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT до значения, включаются в сегмент.
AFTER — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT после значения, включаются в сегмент.
ON — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT в значение, включаются в сегмент. Время в этом сравнении игнорируется.
BETWEEN — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT между значениями, включаются в сегмент.

Values -> (список)

(строка)

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

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

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

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

Duration -> (строка)

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

RecencyType -> (строка)

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

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

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

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

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

DimensionType -> (строка)

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

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

DimensionType -> (строка)

Values -> (список)

(строка)

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

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

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

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

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

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

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

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

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

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

Metrics -> (карта)

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

key -> (строка)

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

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

ComparisonOperator -> (строка)

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

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

UserAttributes -> (карта)

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

key -> (строка)

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

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

AttributeType -> (строка)

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

INCLUSIVE — конечные точки с атрибутами, соответствующими значениям, включаются в сегмент.
EXCLUSIVE — конечные точки с атрибутами, соответствующими значениям, исключаются из сегмента.
CONTAINS — конечные точки, у которых подстроки атрибутов соответствуют значениям, включаются в сегмент.
BEFORE — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT до значения, включаются в сегмент.
AFTER — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT после значения, включаются в сегмент.
ON — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT в значение, включаются в сегмент. Время в этом сравнении игнорируется.
BETWEEN — конечные точки с атрибутами, интерпретируемые как даты ISO_INSTANT между значениями, включаются в сегмент.

Values -> (список)

(строка)

SourceSegments -> (список)

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

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

(структура)

Указывает идентификатор сегмента и версию сегмента.

Id -> (строка)

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

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

Номер версии сегмента.

SourceType -> (строка)

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

Type -> (строка)

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

Include -> (строка)

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

SegmentType -> (строка)

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

DIMENSIONAL - Динамический сегмент, использующий критерии отбора, задаваемые вами, и основанные на данных конечных точек, предоставляемых вашим приложением. Динамические сегменты могут изменяться со временем.
IMPORT - Статический сегмент, использующий критерии отбора, задаваемые вами, и основанные на определениях конечных точек, импортируемых из файла. Импортированные сегменты статичны; они не изменяются со временем.

tags -> (map)

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

key -> (строка)

value -> (строка)

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

Номер версии сегмента.