[ aws . customer-profiles ]
получить-членство-в-сегменте
Описание
Определяет, находятся ли указанные профили в сегменте.
См. также: Документация API AWS
Синтаксис
get-segment-membership
--domain-name <value>
--segment-definition-name <value>
--profile-ids <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-definition-name (строка)
--profile-ids (список)
Список идентификаторов профилей для запроса.
(строка)
Синтаксис:
"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
- текст
- таблица
- 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 (логическое значение)
Отключить автоматическое запрошение параметров ввода командной строки.
Результат
Имя определения сегмента -> (строка)
Профили -> (список)
Массив карт, каждая из которых содержит ответ по запрошенному профилю.
(структура)
Объект, содержащий результаты членства.
Идентификатор профиля -> (строка)
Результат запроса -> (строка)
Профиль -> (структура)
Стандартный профиль клиента.
Идентификатор профиля -> (строка)
Номер счета -> (строка)
Дополнительная информация -> (строка)
Тип стороны -> (строка)
Название компании -> (строка)
Имя -> (строка)
Отчество -> (строка)
Фамилия -> (строка)
Дата рождения -> (строка)
Пол -> (строка)
Номер телефона -> (строка)
Мобильный номер телефона -> (строка)
Домашний номер телефона -> (строка)
Рабочий номер телефона -> (строка)
Адрес электронной почты -> (строка)
Личный адрес электронной почты -> (строка)
Рабочий адрес электронной почты -> (строка)
Адрес -> (структура)
Общий адрес клиента, не являющийся адресом для почтовых отправлений, доставки или выставления счетов.
Адрес 1 -> (строка)
Адрес 2 -> (строка)
Адрес 3 -> (строка)
Адрес 4 -> (строка)
Город -> (строка)
Район -> (строка)
Штат -> (строка)
Провинция -> (строка)
Страна -> (строка)
Почтовый индекс -> (строка)
Адрес доставки -> (структура)
Адрес доставки клиента.
Адрес 1 -> (строка)
Адрес 2 -> (строка)
Адрес 3 -> (строка)
Адрес 4 -> (строка)
Город -> (строка)
Район -> (строка)
Штат -> (строка)
Провинция -> (строка)
Страна -> (строка)
Почтовый индекс -> (строка)
Почтовый адрес -> (структура)
Почтовый адрес клиента.
Адрес 1 -> (строка)
Адрес 2 -> (строка)
Адрес 3 -> (строка)
Адрес 4 -> (строка)
Город -> (строка)
Район -> (строка)
Штат -> (строка)
Провинция -> (строка)
Страна -> (строка)
Почтовый индекс -> (строка)
Адрес для выставления счетов -> (структура)
Адрес выставления счетов клиента.
Адрес 1 -> (строка)
Адрес 2 -> (строка)
Адрес 3 -> (строка)
Адрес 4 -> (строка)
Город -> (строка)
Район -> (строка)
Штат -> (строка)
Провинция -> (строка)
Страна -> (строка)
Почтовый индекс -> (строка)
Атрибуты -> (карта)
Пара ключ-значение атрибутов профиля клиента.
ключ -> (строка)
значение -> (строка)
Найденные элементы -> (список)
Список элементов, использованных для поиска профиля в ответе SearchProfiles. Элемент — это пара ключ-значение, которая соответствует атрибуту в профиле.
Если параметр AdditionalSearchKeys был включён в запрос SearchProfiles, список FoundByItems должен интерпретироваться на основе LogicalOperator, использованного в запросе:
-
AND— профиль в ответе соответствует всем ключам поиска, указанным в запросе. СписокFoundByItemsбудет содержать все пары ключ-значение, указанные в запросе (так как это требование логики поискаAND). -
OR— профиль в ответе соответствует по крайней мере одному из ключей поиска, указанных в запросе. СписокFoundByItemsбудет содержать каждую пару ключ-значение, по которой был найден профиль.
Отношение OR является стандартным поведением, если параметр LogicalOperator не включён в запрос SearchProfiles.
(структура)
Тип данных, состоящий из KeyName и списка Values, использованных для поиска профиля в ответе на запрос SearchProfiles.
Имя ключа -> (строка)
Значения -> (список)
Список значений ключей.
(строка)
Тип стороны (строка) -> (строка)
Пол (строка) -> (строка)
Ошибки -> (список)
Массив карт, каждая из которых содержит ответ по профилю, не обработанному запросом.
(структура)
Объект, содержащий ошибки членства.
Идентификатор профиля -> (строка)
Сообщение -> (строка)
Статус -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.