Spec-Zone.ru › AWS CLI v2

[ aws . rekognition ]

create-face-liveness-session

Описание

Эта операция API инициирует сеанс распознавания живого лица. Она возвращает SessionId, который можно использовать для начала потоковой передачи видео распознавания живого лица и получения результатов сеанса распознавания живого лица.

Вы можете использовать параметр OutputConfig в параметре Settings, чтобы указать расположение ведра Amazon S3. Ведро Amazon S3 хранит эталонные изображения и аудиторные изображения. Если ведро Amazon S3 не определено, вместо этого отправляются исходные байты.

Вы можете использовать AuditImagesLimit, чтобы ограничить количество аудиторных изображений, возвращаемых при вызове GetFaceLivenessSessionResults. Это число находится в диапазоне от 0 до 4. По умолчанию оно установлено в 0. Ограничение носит рекомендательный характер и основано на продолжительности видео селфи.

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

Синтаксис

  create-face-liveness-session
[--kms-key-id <value>]
[--settings <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]

Параметры

--kms-key-id (строка)

Идентификатор ключа управления ключами AWS (ключ AWS KMS). Используется для шифрования аудиторных изображений и эталонных изображений.

--settings (структура)

Объект настроек сеанса. Он содержит настройки для выполняемой операции. Для распознавания живого лица он принимает OutputConfig и AuditImagesLimit.

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

Можно указать расположение ведра Amazon S3, где будут храниться эталонные и аудиторные изображения. Обратите внимание, что ведро Amazon S3 должно находиться в учетной записи AWS вызывающей стороны и в той же области, что и конечная точка распознавания живого лица. Кроме того, ключи объектов Amazon S3 автоматически генерируются системой распознавания живого лица. Требуется, чтобы вызывающая сторона имела разрешение s3:PutObject на ведро Amazon S3.

S3Bucket -> (строка)

Путь к ведру AWS Amazon S3, используемому для хранения результатов сеанса распознавания живого лица.

S3KeyPrefix -> (строка)

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

AuditImagesLimit -> (целое число)

Количество аудиторных изображений, которые нужно вернуть. Принимает целое число от 0 до 4. Любое целое число меньше 0 вернет 0, любое целое число больше 4 вернет 4 изображения в ответ. По умолчанию оно установлено в 0. Ограничение носит рекомендательный характер и основано на фактической продолжительности видео селфи.

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

OutputConfig={S3Bucket=string,S3KeyPrefix=string},AuditImagesLimit=integer

Синтаксис JSON:

{
  "OutputConfig": {
    "S3Bucket": "string",
    "S3KeyPrefix": "string"
  },
  "AuditImagesLimit": integer
}

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

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

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

Вывод

SessionId -> (строка)

Уникальный 128-битный UUID, идентифицирующий сеанс распознавания живого лица. Для каждого проверки живого лица должен использоваться новый sessionID. Если один и тот же sessionID используется для последующих проверок живого лица, проверки завершатся с ошибкой. Кроме того, sessionID истекает через 3 минуты после отправки, что делает недоступными все данные распознавания живого лица, связанные с сеансом (например, sessionID, эталонное изображение, аудиторные изображения и т. д.).

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

Spec-Zone.ru

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