Get Face Liveness Session Results
rekognition_get_face_liveness_session_results | R Documentation |
Retrieves the results of a specific Face Liveness session¶
Description¶
Retrieves the results of a specific Face Liveness session. It requires
the sessionId
as input, which was created using
create_face_liveness_session
. Returns the corresponding Face Liveness
confidence score, a reference image that includes a face bounding box,
and audit images that also contain face bounding boxes. The Face
Liveness confidence score ranges from 0 to 100.
The number of audit images returned by
get_face_liveness_session_results
is defined by the AuditImagesLimit
paramater when calling create_face_liveness_session
. Reference images
are always returned when possible.
Usage¶
Arguments¶
SessionId
[required] A unique 128-bit UUID. This is used to uniquely identify the session and also acts as an idempotency token for all operations associated with the session.
Value¶
A list with the following syntax:
list(
SessionId = "string",
Status = "CREATED"|"IN_PROGRESS"|"SUCCEEDED"|"FAILED"|"EXPIRED",
Confidence = 123.0,
ReferenceImage = list(
Bytes = raw,
S3Object = list(
Bucket = "string",
Name = "string",
Version = "string"
),
BoundingBox = list(
Width = 123.0,
Height = 123.0,
Left = 123.0,
Top = 123.0
)
),
AuditImages = list(
list(
Bytes = raw,
S3Object = list(
Bucket = "string",
Name = "string",
Version = "string"
),
BoundingBox = list(
Width = 123.0,
Height = 123.0,
Left = 123.0,
Top = 123.0
)
)
)
)