Create Face Liveness Session
rekognition_create_face_liveness_session | R Documentation |
This API operation initiates a Face Liveness session¶
Description¶
This API operation initiates a Face Liveness session. It returns a
SessionId
, which you can use to start streaming Face Liveness video
and get the results for a Face Liveness session.
You can use the OutputConfig
option in the Settings parameter to
provide an Amazon S3 bucket location. The Amazon S3 bucket stores
reference images and audit images. If no Amazon S3 bucket is defined,
raw bytes are sent instead.
You can use AuditImagesLimit
to limit the number of audit images
returned when get_face_liveness_session_results
is called. This number
is between 0 and 4. By default, it is set to 0. The limit is best effort
and based on the duration of the selfie-video.
Usage¶
Arguments¶
KmsKeyId
The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.
Settings
A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts
OutputConfig
andAuditImagesLimit
.ClientRequestToken
Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple
create_face_liveness_session
requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
Value¶
A list with the following syntax: