CreateFaceLivenessSessionRequest Class

Container for the parameters to the CreateFaceLivenessSession operation. 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 GetFaceLivenessSessionResults 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.CreateFaceLivenessSessionRequest

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

public class CreateFaceLivenessSessionRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The CreateFaceLivenessSessionRequest type exposes the following members

Constructors

	Name	Description
	CreateFaceLivenessSessionRequest()

Properties

Name Type Description

Name	Type	Description
ClientRequestToken	System.String	Gets and sets the property ClientRequestToken. Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple `CreateFaceLivenessSession` requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.
KmsKeyId	System.String	Gets and sets the property KmsKeyId. The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.
Settings	Amazon.Rekognition.Model.CreateFaceLivenessSessionRequestSettings	Gets and sets the property Settings. A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts `OutputConfig` and `AuditImagesLimit`.

ClientRequestToken

System.String

Gets and sets the property ClientRequestToken.

Idempotent token is used to recognize the Face Liveness request. If the same token is used with multiple CreateFaceLivenessSession requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

KmsKeyId

System.String

Gets and sets the property KmsKeyId.

The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt audit images and reference images.

Settings

Amazon.Rekognition.Model.CreateFaceLivenessSessionRequestSettings

Gets and sets the property Settings.

A session settings object. It contains settings for the operation to be performed. For Face Liveness, it accepts OutputConfig and AuditImagesLimit.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5