Spec-Zone.ru › AWS CLI v2

[ aws . rekognition ]

поиск-пользователей

Описание

Ищет идентификаторы пользователей (UserID) в коллекции на основе FaceId или UserId. Этот API можно использовать для поиска ближайшего идентификатора пользователя (с наибольшим сходством) для сопоставления лица. Запрос должен быть предоставлен либо с FaceId, либо с UserId. Операция возвращает массив идентификаторов пользователей, которые соответствуют FaceId или UserId, отсортированный по баллу сходства, начиная с наибольшего сходства.

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

Синтаксис

  search-users
--collection-id <value>
[--user-id <value>]
[--face-id <value>]
[--user-match-threshold <value>]
[--max-users <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]

Параметры

--collection-id (строка)

Идентификатор существующей коллекции, содержащей идентификаторы пользователей (UserID), используется с UserID или FaceID. Если предоставлен FaceID, UserID не требуется для наличия в коллекции.

--user-id (строка)

Идентификатор существующего пользователя.

--face-id (строка)

Идентификатор существующего лица.

--user-match-threshold (число с плавающей точкой)

Необязательное значение, определяющее минимальную уверенность в сопоставленном идентификаторе пользователя для возврата. Значение по умолчанию 80.

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

Максимальное количество идентичностей для возврата.

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

Вывод

UserMatches -> (список)

Массив объектов UserMatch, которые соответствуют введённому лицу, вместе с уверенностью в соответствии. Массив будет пустым, если совпадений нет.

(структура)

Предоставляет метаданные UserID вместе с уверенностью в соответствии этого UserID с введённым лицом.

Сходство -> (число с плавающей точкой)

Описание метаданных UserID.

Пользователь -> (структура)

Уверенность в соответствии этого UserID с введённым лицом.

UserId -> (строка)

Предоставленный идентификатор UserID. Уникален в рамках коллекции.

СтатусПользователя -> (строка)

Статус пользователя, соответствующего предоставленному FaceID.

FaceModelVersion -> (строка)

Номер версии модели распознавания лиц, связанной с введённым CollectionId.

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

Содержит идентификатор лица, который использовался для поиска совпадений в коллекции.

FaceId -> (строка)

Уникальный идентификатор, присвоенный лицу.

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

Содержит идентификатор UserID, который использовался для поиска совпадений в коллекции.

UserId -> (строка)

Предоставленный идентификатор UserID. Уникален в рамках коллекции.

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

Spec-Zone.ru

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