Spec-Zone.ru › AWS CLI v2

[ 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.

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API