create-segment

Description

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

См. также: AWS API Documentation

Synopsis

  create-segment
--application-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]

Options

--application-id (string)

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

--write-segment-request (structure)

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

Dimensions -> (structure)

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

Attributes -> (map)

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

key -> (string)

value -> (structure)

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

AttributeType -> (string)

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

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

Values -> (list)

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

(string)

Behavior -> (structure)

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

Recency -> (structure)

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

Duration -> (string)

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

RecencyType -> (string)

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

Demographic -> (structure)

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

AppVersion -> (structure)

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

DimensionType -> (string)

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

Values -> (list)

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

(string)

Channel -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

DeviceType -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Make -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Model -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Platform -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Location -> (structure)

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

Country -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

GPSPoint -> (structure)

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

Coordinates -> (structure)

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

Latitude -> (double)

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

Longitude -> (double)

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

RangeInKilometers -> (double)

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

Metrics -> (map)

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

key -> (string)

value -> (structure)

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

ComparisonOperator -> (string)

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

Value -> (double)

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

UserAttributes -> (map)

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

key -> (string)

value -> (structure)

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

AttributeType -> (string)

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

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

Values -> (list)

(string)

Name -> (string)

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

SegmentGroups -> (structure)

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

Groups -> (list)

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

(structure)

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

Dimensions -> (list)

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

(structure)

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

Attributes -> (map)

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

key -> (string)

value -> (structure)

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

AttributeType -> (string)

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

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

Values -> (list)

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

(string)

Behavior -> (structure)

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

Recency -> (structure)

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

Duration -> (string)

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

RecencyType -> (string)

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

Demographic -> (structure)

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

AppVersion -> (structure)

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

DimensionType -> (string)

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

Values -> (list)

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

(string)

Channel -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

DeviceType -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Make -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Model -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Platform -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

Location -> (structure)

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

Country -> (structure)

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

DimensionType -> (string)

Values -> (list)

(string)

GPSPoint -> (structure)

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

Coordinates -> (structure)

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

Latitude -> (double)

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

Longitude -> (double)

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

RangeInKilometers -> (double)

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

Metrics -> (map)

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

key -> (string)

value -> (structure)

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

ComparisonOperator -> (string)

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

Value -> (double)

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

UserAttributes -> (map)

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

key -> (string)

value -> (structure)

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

AttributeType -> (string)

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

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

Values -> (list)

(string)

SourceSegments -> (list)

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

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

(structure)

Определяет идентификатор сегмента и версию сегмента.

Id -> (string)

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

Version -> (integer)

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

SourceType -> (string)

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

Type -> (string)

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

Include -> (string)

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

tags -> (map)

Примечание

По состоянию на 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
таблица
yaml
yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

включено
выключено
автоматически

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

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

(строка)

Id -> (строка)

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

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

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

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

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

key -> (строка)

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

ExternalId -> (строка)

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

Format -> (строка)

Формат файлов, которые были импортированы для создания сегмента. Допустимые значения: CSV, для формата 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 -> (структура)

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

Группы -> (список)

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

(структура)

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

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

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

(структура)

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

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

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

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

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

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

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

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

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

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

(структура)

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

Id -> (строка)

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

Версия -> (целое число)

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

ТипИсточника -> (строка)

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

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

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

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

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

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

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

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

tags -> (map)

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

key -> (string)

value -> (string)

Version -> (integer)

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