Spec-Zone.ru › AWS CLI v2

[ aws . customer-profiles ]

поиск-профилей

Описание

Ищет профили в определённом домене, используя один или несколько предопределённых ключей поиска (например, _fullName, _phone, _email, _account и т. д.) и/или пользовательские ключи поиска. Ключ поиска — это пара типов данных, состоящая из KeyName и Values списка.

Данная операция поддерживает поиск профилей с минимальным количеством 1 пары ключ-значение и до 5 пар ключ-значение, используя логику AND или OR.

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

Синтаксис

  search-profiles
[--next-token <value>]
[--max-results <value>]
--domain-name <value>
--key-name <value>
--values <value>
[--additional-search-keys <value>]
[--logical-operator <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]

Параметры

--next-token (строка)

Маркер постраничной навигации из предыдущего вызова API SearchProfiles.

--max-results (целое число)

Максимальное количество объектов, возвращаемых на странице.

По умолчанию — 20, если этот параметр не указан в запросе.

--domain-name (строка)

Уникальное имя домена.

--key-name (строка)

Поисковый идентификатор профиля клиента. Предопределённые ключи, которые можно использовать для поиска: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId, _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId, _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId, _shopifyOrderId.

--values (список)

Список значений ключей.

(строка)

Синтаксис:

"string" "string" ...

--additional-search-keys (список)

Список AdditionalSearchKey объектов, каждый из которых является поисковым идентификатором профиля. Каждый AdditionalSearchKey объект содержит KeyName и список Values, связанных с этим конкретным ключом (т. е. пару ключ-значение). Эти дополнительные ключи поиска будут использоваться совместно с LogicalOperator и обязательными KeyName и Values параметрами для поиска профилей, удовлетворяющих критериям поиска.

(структура)

Пара типов данных, состоящая из KeyName и Values списка, используемого совместно с параметрами KeyName и Values для поиска профилей с помощью API SearchProfiles.

KeyName -> (строка)

Поисковый идентификатор профиля клиента.

Values -> (список)

Список значений ключей.

(строка)

Сокращённый синтаксис:

KeyName=string,Values=string,string ...

Синтаксис JSON:

[
  {
    "KeyName": "string",
    "Values": ["string", ...]
  }
  ...
]

--logical-operator (строка)

Взаимосвязь между всеми указанными ключами поиска, которые будут использоваться для поиска профилей. Это включает обязательные параметры KeyName и Values, а также любые пары ключ-значение, указанные в списке AdditionalSearchKeys.

Данный параметр влияет на то, какие профили будут возвращены в ответе следующим образом:

  • AND — в ответ включаются только профили, соответствующие всем ключам поиска.
  • OR — в ответ включаются профили, соответствующие хотя бы одному из ключей поиска.

Отношение OR является по умолчанию, если этот параметр не указан в запросе.

Возможные значения:

  • AND
  • OR

--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 для вывода.

--cli-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

Элементы -> (список)

Список профилей, соответствующих критериям поиска.

(структура)

Стандартный профиль клиента.

ProfileId -> (строка)

Уникальный идентификатор профиля клиента.

AccountNumber -> (строка)

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

AdditionalInformation -> (строка)

Любая дополнительная информация, относящаяся к профилю клиента.

PartyType -> (строка)

Тип профиля, используемого для описания клиента.

BusinessName -> (строка)

Название бизнеса клиента.

FirstName -> (строка)

Имя клиента.

MiddleName -> (строка)

Отчество клиента.

LastName -> (строка)

Фамилия клиента.

BirthDate -> (строка)

Дата рождения клиента.

Gender -> (строка)

Пол клиента.

PhoneNumber -> (строка)

Номер телефона клиента, не указанный как мобильный, домашний или рабочий.

MobilePhoneNumber -> (строка)

Мобильный номер телефона клиента.

HomePhoneNumber -> (строка)

Домашний номер телефона клиента.

BusinessPhoneNumber -> (строка)

Рабочий номер телефона клиента.

EmailAddress -> (строка)

Электронный адрес клиента, не указанный как личный или рабочий.

PersonalEmailAddress -> (строка)

Личный электронный адрес клиента.

BusinessEmailAddress -> (строка)

Рабочий электронный адрес клиента.

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

Общий адрес клиента, не относящийся к почтовому, отправляемому или счётному адресам.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город, в котором проживает клиент.

County -> (строка)

Район, в котором проживает клиент.

State -> (строка)

Штат, в котором проживает клиент.

Province -> (строка)

Провинция, в которой проживает клиент.

Country -> (строка)

Страна, в которой проживает клиент.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Адрес доставки клиента.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город, в котором проживает клиент.

County -> (строка)

Район, в котором проживает клиент.

State -> (строка)

Штат, в котором проживает клиент.

Province -> (строка)

Провинция, в которой проживает клиент.

Country -> (строка)

Страна, в которой проживает клиент.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Почтовый адрес клиента.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город, в котором проживает клиент.

County -> (строка)

Район, в котором проживает клиент.

State -> (строка)

Штат, в котором проживает клиент.

Province -> (строка)

Провинция, в которой проживает клиент.

Country -> (строка)

Страна, в которой проживает клиент.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

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

Адрес для выставления счетов клиенту.

Address1 -> (строка)

Первая строка адреса клиента.

Address2 -> (строка)

Вторая строка адреса клиента.

Address3 -> (строка)

Третья строка адреса клиента.

Address4 -> (строка)

Четвертая строка адреса клиента.

City -> (строка)

Город, в котором проживает клиент.

County -> (строка)

Район, в котором проживает клиент.

State -> (строка)

Штат, в котором проживает клиент.

Province -> (строка)

Провинция, в которой проживает клиент.

Country -> (строка)

Страна, в которой проживает клиент.

PostalCode -> (строка)

Почтовый индекс адреса клиента.

Attributes -> (карта)

Пара ключ-значение атрибутов профиля клиента.

key -> (строка)

value -> (строка)

FoundByItems -> (список)

Список элементов, используемых для поиска профиля в ответе SearchProfiles. Элемент — это пара ключ-значение, соответствующая атрибуту в профиле.

Если необязательный AdditionalSearchKeys параметр был включён в запрос SearchProfiles, список FoundByItems следует интерпретировать на основе LogicalOperator, используемого в запросе:

  • AND - Профиль в ответе соответствует всем ключам поиска, указанным в запросе. Список FoundByItems будет содержать все пары ключ-значение, указанные в запросе (так как это требование логики поиска AND).
  • OR - Профиль в ответе соответствует хотя бы одному из ключей поиска, указанных в запросе. Список FoundByItems будет содержать каждую пару ключ-значение, по которой был найден профиль.

Отношение OR является стандартным поведением, если параметр LogicalOperator не включён в запрос SearchProfiles.

(структура)

Тип данных, состоящий из KeyName и списка Values, использованных для поиска профиля, возвращённого в ответ на запрос SearchProfiles.

KeyName -> (строка)

Поисковый идентификатор профиля клиента.

Values -> (список)

Список значений ключей.

(строка)

PartyTypeString -> (строка)

Альтернатива PartyType, принимающая любой строковый ввод.

GenderString -> (строка)

Альтернатива Gender, принимающая любой строковый ввод.

NextToken -> (строка)

Токен постраничной навигации из предыдущего вызова API SearchProfiles.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

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