Class: AWSCDK::Rekognition::CfnStreamProcessor::FaceSearchSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Rekognition::CfnStreamProcessor::FaceSearchSettingsProperty

Defined in:

rekognition/cfn_stream_processor.rb

Overview

The input parameters used to recognize faces in a streaming video analyzed by a Amazon Rekognition stream processor.

FaceSearchSettings is a request parameter for CreateStreamProcessor . For more information, see FaceSearchSettings .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html

Instance Attribute Summary

• #collection_id ⇒ String readonly

  The ID of a collection that contains faces that you want to search for.

• #face_match_threshold ⇒ Numeric^? readonly

  Minimum face match confidence score that must be met to return a result for a recognized face.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(collection_id:, face_match_threshold: nil) ⇒ FaceSearchSettingsProperty constructor

  A new instance of FaceSearchSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(collection_id:, face_match_threshold: nil) ⇒ FaceSearchSettingsProperty

Returns a new instance of FaceSearchSettingsProperty.

Parameters:

• collection_id (String) —

  The ID of a collection that contains faces that you want to search for.

• face_match_threshold (Numeric, nil) (defaults to: nil) —

  Minimum face match confidence score that must be met to return a result for a recognized face.

# File 'rekognition/cfn_stream_processor.rb', line 864

def initialize(collection_id:, face_match_threshold: nil)
  @collection_id = collection_id
  Jsii::Type.check_type(@collection_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "collectionId")
  @face_match_threshold = face_match_threshold
  Jsii::Type.check_type(@face_match_threshold, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "faceMatchThreshold") unless @face_match_threshold.nil?
end

Instance Attribute Details

#collection_id ⇒ String (readonly)

The ID of a collection that contains faces that you want to search for.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html#cfn-rekognition-streamprocessor-facesearchsettings-collectionid

# File 'rekognition/cfn_stream_processor.rb', line 875

def collection_id
  @collection_id
end

#face_match_threshold ⇒ Numeric^? (readonly)

Minimum face match confidence score that must be met to return a result for a recognized face.

The default is 80. 0 is the lowest confidence. 100 is the highest confidence. Values between 0 and 100 are accepted, and values lower than 80 are set to 80.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rekognition-streamprocessor-facesearchsettings.html#cfn-rekognition-streamprocessor-facesearchsettings-facematchthreshold

# File 'rekognition/cfn_stream_processor.rb', line 882

def face_match_threshold
  @face_match_threshold
end

Class Method Details

.jsii_properties ⇒ Object

# File 'rekognition/cfn_stream_processor.rb', line 884

def self.jsii_properties
  {
    :collection_id => "collectionId",
    :face_match_threshold => "faceMatchThreshold",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'rekognition/cfn_stream_processor.rb', line 891

def to_jsii
  result = {}
  result.merge!({
    "collectionId" => @collection_id,
    "faceMatchThreshold" => @face_match_threshold,
  })
  result.compact
end