Class: Aws::Rekognition::Types::CreateFaceLivenessSessionRequestSettings

Inherits:

Struct

Object
Struct
Aws::Rekognition::Types::CreateFaceLivenessSessionRequestSettings

show all

Includes:: Structure

Defined in:: lib/aws-sdk-rekognition/types.rb

Overview

A session settings object. It contains settings for the operation to be performed. It accepts arguments for OutputConfig and AuditImagesLimit.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#audit_images_limit ⇒ Integer

Number of audit images to be returned back.
#output_config ⇒ Types::LivenessOutputConfig

Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored.

Instance Attribute Details

#audit_images_limit ⇒ `Integer`

Number of audit images to be returned back. Takes an integer between 0-4. Any integer less than 0 will return 0, any integer above 4 will return 4 images in the response. By default, it is set to 0. The limit is best effort and is based on the actual duration of the selfie-video.

Returns:

(Integer)

# File 'lib/aws-sdk-rekognition/types.rb', line 977

class CreateFaceLivenessSessionRequestSettings < Struct.new(
  :output_config,
  :audit_images_limit)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ `Types::LivenessOutputConfig`

Can specify the location of an Amazon S3 bucket, where reference and audit images will be stored. Note that the Amazon S3 bucket must be located in the caller’s AWS account and in the same region as the Face Liveness end-point. Additionally, the Amazon S3 object keys are auto-generated by the Face Liveness system. Requires that the caller has the ‘s3:PutObject` permission on the Amazon S3 bucket.