[ aws . customer-profiles ]
create-segment-estimate
Описание
Создает запрос оценки сегмента.
См. также: Документацию API AWS
Синтаксис
create-segment-estimate
--domain-name <value>
--segment-query <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]
Параметры
--domain-name (строка)
--segment-query (структура)
Запрос сегмента для расчета оценки сегмента.
Groups -> (список)
Содержит список групп в определении сегмента.
(структура)
Содержит размеры, определяющие, на чем сегментировать.
Dimensions -> (список)
Определяет атрибуты для сегментации.
(структура помеченного объединения)
Объект, содержащий профиль и вычисленные атрибуты для сегментации.
Примечание
Это структура помеченного объединения. Только один из следующих верхних ключей может быть установлен:ProfileAttributes, CalculatedAttributes.ProfileAttributes -> (структура)
Объект, содержащий атрибуты профиля для сегментации.
AccountNumber -> (структура)
Поле для описания значений для сегментации в рамках номера счета.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
AdditionalInformation -> (структура)
Поле для описания значений для сегментации в дополнительной информации.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
FirstName -> (структура)
Поле для описания значений для сегментации в имени.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
LastName -> (структура)
Поле для описания значений для сегментации в фамилии.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
MiddleName -> (структура)
Поле для описания значений для сегментации в отчестве.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
GenderString -> (структура)
Поле для описания значений для сегментации в строке пола.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
PartyTypeString -> (структура)
Поле для описания значений для сегментации в строке типа стороны.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
BirthDate -> (структура)
Поле для описания значений для сегментации в дате рождения.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
PhoneNumber -> (структура)
Поле для описания значений для сегментации в номере телефона.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
BusinessName -> (структура)
Поле для описания значений для сегментации в названии бизнеса.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
BusinessPhoneNumber -> (структура)
Поле для описания значений для сегментации в номере телефона бизнеса.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
HomePhoneNumber -> (структура)
Поле для описания значений для сегментации в домашнем номере телефона.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
MobilePhoneNumber -> (структура)
Поле для описания значений для сегментации в мобильном номере телефона.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
EmailAddress -> (структура)
Поле для описания значений для сегментации в адресе электронной почты.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
PersonalEmailAddress -> (структура)
Поле для описания значений для сегментации в личном адресе электронной почты.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
BusinessEmailAddress -> (структура)
Поле для описания значений для сегментации в деловом адресе электронной почты.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Address -> (структура)
Поле для описания значений для сегментации в адресе.
City -> (структура)
Город, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Country -> (структура)
Страна, относящаяся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
County -> (структура)
Уезд, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
PostalCode -> (структура)
Почтовый индекс, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Province -> (структура)
Провинция, относящаяся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
State -> (структура)
Штат, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
ShippingAddress -> (структура)
Поле для описания значений для сегментации в адрес доставки.
City -> (структура)
Город, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Country -> (структура)
Страна, относящаяся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
County -> (структура)
Уезд, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
PostalCode -> (структура)
Почтовый индекс, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Province -> (структура)
Провинция, относящаяся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
State -> (структура)
Штат, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
MailingAddress -> (структура)
Поле для описания значений для сегментации в адрес для корреспонденции.
City -> (структура)
Город, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Country -> (структура)
Страна, относящаяся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
County -> (структура)
Уезд, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
PostalCode -> (структура)
Почтовый индекс, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
Province -> (структура)
Провинция, относящаяся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
State -> (структура)
Штат, относящийся к адресу.
DimensionType -> (строка)
Values -> (список)
Значения для применения DimensionType.
(строка)
BillingAddress -> (структура)
Поле для описания значений для сегментации по адресу выставления счетов.
Город -> (структура)
Город, принадлежащий адресу.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
Страна -> (структура)
Страна, принадлежащая адресу.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
Уезд -> (структура)
Уезд, принадлежащий адресу.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
ПочтовыйИндекс -> (структура)
Почтовый индекс, принадлежащий адресу.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
Провинция -> (структура)
Провинция, принадлежащая адресу.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
Штат -> (структура)
Штат, принадлежащий адресу.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
Атрибуты -> (отображение)
Поле для описания значений для сегментации по атрибутам.
ключ -> (строка)
значение -> (структура)
Объект, сегментирующий по различным полям профиля клиента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
ВычисленныеАтрибуты -> (отображение)
Объект, содержащий вычисленные атрибуты для сегментации.
ключ -> (строка)
значение -> (структура)
Объект, сегментирующий по вычисленным атрибутам профиля клиента.
ТипИзмерения -> (строка)
Значения -> (список)
Значения для применения типа измерения.
(строка)
НастройкаУсловий -> (структура)
Применяет данное условие к определению исходного вычисленного атрибута.
Диапазон -> (структура)
Относительный период времени, в течение которого данные включаются в агрегацию для данной замены.
Начало -> (целое число)
Конец -> (целое число)
Единица -> (строка)
ИсходныеСегменты -> (список)
Определяет исходный источник данных.
(структура)
Сегменты источника, на основе которых происходит построение.
ИмяОпределенияСегмента -> (строка)
ТипИсточника -> (строка)
Тип -> (строка)
Включить -> (строка)
Синтаксис JSON:
{
"Groups": [
{
"Dimensions": [
{
"ProfileAttributes": {
"AccountNumber": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"AdditionalInformation": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"FirstName": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"LastName": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"MiddleName": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"GenderString": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"PartyTypeString": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"BirthDate": {
"DimensionType": "BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON",
"Values": ["string", ...]
},
"PhoneNumber": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"BusinessName": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"BusinessPhoneNumber": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"HomePhoneNumber": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"MobilePhoneNumber": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"EmailAddress": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"PersonalEmailAddress": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"BusinessEmailAddress": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Address": {
"City": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Country": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"County": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"PostalCode": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Province": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"State": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
}
},
"ShippingAddress": {
"City": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Country": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"County": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"PostalCode": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Province": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"State": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
}
},
"MailingAddress": {
"City": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Country": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"County": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"PostalCode": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Province": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"State": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
}
},
"BillingAddress": {
"City": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Country": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"County": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"PostalCode": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"Province": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
},
"State": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
"Values": ["string", ...]
}
},
"Attributes": {"string": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL",
"Values": ["string", ...]
}
...}
},
"CalculatedAttributes": {"string": {
"DimensionType": "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL",
"Values": ["string", ...],
"ConditionOverrides": {
"Range": {
"Start": integer,
"End": integer,
"Unit": "DAYS"
}
}
}
...}
}
...
],
"SourceSegments": [
{
"SegmentDefinitionName": "string"
}
...
],
"SourceType": "ALL"|"ANY"|"NONE",
"Type": "ALL"|"ANY"|"NONE"
}
...
],
"Include": "ALL"|"ANY"|"NONE"
}
--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
- текст
- таблица
- 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-auto-prompt (логическое значение)
Автоматически запросить параметры ввода командной строки.
--no-cli-auto-prompt (логическое значение)
Отключить автоматическое запрос параметров ввода командной строки.
Вывод
ИмяДомена -> (строка)
ИдентификаторОценки -> (строка)
GetSegmentEstimate для получения состояния оценки сегмента.КодСостояния -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.