Spec-Zone.ru › AWS CLI v2

[ aws . rekognition ]

associate-faces

Описание

Связывает один или несколько лиц с существующим идентификатором пользователя. Принимает массив FaceIds. Каждое FaceId, присутствующее в списке FaceIds, связывается с предоставленным идентификатором пользователя. Максимальное количество FaceIds на один идентификатор пользователя составляет 100.

Параметр UserMatchThreshold определяет минимальную уверенность в совпадении пользователя, необходимую для того, чтобы лицо было связано с идентификатором пользователя, с которым уже связано хотя бы одно FaceID. Это гарантирует, что FaceIds связаны с правильным идентификатором пользователя. Значение варьируется от 0 до 100, а значение по умолчанию равно 75.

В случае успеха возвращается массив объектов AssociatedFace, содержащих связанные FaceIds. Если данное лицо уже связано с данным UserID, оно будет проигнорировано и не будет возвращено в ответе. Если данное лицо уже связано с другим UserID, не найдено в коллекции, не соответствует UserMatchThreshold или с UserID уже связано 100 лиц, оно будет возвращено в качестве части массива UnsuccessfulFaceAssociations..

UserStatus отражает состояние операции, которая обновляет представление идентификатора пользователя списком заданных лиц. UserStatus может быть:

  • ACTIVE - Все ассоциации или диссоциации FaceID(ов) для идентификатора пользователя завершены.
  • CREATED - Идентификатор пользователя был создан, но с ним не связаны никакие FaceID(ы).
  • UPDATING - Идентификатор пользователя обновляется, и в настоящее время происходят текущие ассоциации или диссоциации FaceID(ов).

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

Синтаксис

  associate-faces
--collection-id <value>
--user-id <value>
--face-ids <value>
[--user-match-threshold <value>]
[--client-request-token <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 (строка)

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

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

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

--face-ids (список)

Массив FaceID, которые необходимо связать с идентификатором пользователя.

(строка)

Синтаксис:

"string" "string" ...

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

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

--client-request-token (строка)

Идентификатор, используемый для идентификации запроса к AssociateFaces. Если вы используете один и тот же идентификатор с несколькими запросами AssociateFaces, возвращается тот же ответ. Используйте ClientRequestToken, чтобы предотвратить обработку одного и того же запроса более одного раза.

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

Вывод

AssociatedFaces -> (список)

Массив объектов AssociatedFace, содержащих FaceID, успешно связанные с идентификатором пользователя. Возвращается, если действие AssociateFaces успешно.

(структура)

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

FaceId -> (строка)

Уникальный идентификатор, назначенный лицу.

UnsuccessfulFaceAssociations -> (список)

Массив объектов UnsuccessfulAssociation, содержащих FaceID, которые не были успешно связаны, а также причины. Возвращается, если действие AssociateFaces выполняется успешно.

(структура)

Содержит метаданные, такие как FaceId, UserID и Reasons, для лица, которое не было успешно связано.

FaceId -> (строка)

Уникальный идентификатор, назначенный лицу.

UserId -> (строка)

Предоставленный идентификатор для идентификатора пользователя. Уникальный в пределах коллекции.

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

Уверенность в совпадении с идентификатором пользователя, предоставляет информацию о том, была ли ассоциация лица неуспешной, потому что она не соответствовала UserMatchThreshold.

Reasons -> (список)

Причина неудачи ассоциации.

(строка)

UserStatus -> (строка)

Состояние обновления, внесенного в идентификатор пользователя. Отражает, был ли идентификатор пользователя обновлен для каждого запрошенного изменения.

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

Spec-Zone.ru

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