Class: Aws::Rekognition::Types::StartFaceSearchRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::StartFaceSearchRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_request_token ⇒ String

  Idempotent token used to identify the start request.

• #collection_id ⇒ String

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

• #face_match_threshold ⇒ Float

  The minimum confidence in the person match to return.

• #job_tag ⇒ String

  An identifier you specify that’s returned in the completion notification that’s published to your Amazon Simple Notification Service topic.

• #notification_channel ⇒ Types::NotificationChannel

  The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search.

• #video ⇒ Types::Video

  The video you want to search.

Instance Attribute Details

#client_request_token ⇒ String

Idempotent token used to identify the start request. If you use the same token with multiple ‘StartFaceSearch` requests, the same `JobId` is returned. Use `ClientRequestToken` to prevent the same job from being accidently started more than once.

Returns:

• (String)

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

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#collection_id ⇒ String

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

Returns:

• (String)

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

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#face_match_threshold ⇒ Float

The minimum confidence in the person match to return. For example, don’t return any matches where confidence in matches is less than 70%. The default value is 80%.

Returns:

• (Float)

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

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#job_tag ⇒ String

An identifier you specify that’s returned in the completion notification that’s published to your Amazon Simple Notification Service topic. For example, you can use ‘JobTag` to group related jobs and identify them in the completion notification.

Returns:

• (String)

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

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#notification_channel ⇒ Types::NotificationChannel

The ARN of the Amazon SNS topic to which you want Amazon Rekognition Video to publish the completion status of the search. The Amazon SNS topic must have a topic name that begins with AmazonRekognition if you are using the AmazonRekognitionServiceRole permissions policy to access the topic.

Returns:

• (Types::NotificationChannel)

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

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end

#video ⇒ Types::Video

The video you want to search. The video must be stored in an Amazon S3 bucket.

Returns:

• (Types::Video)

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

class StartFaceSearchRequest < Struct.new(
  :video,
  :client_request_token,
  :face_match_threshold,
  :collection_id,
  :notification_channel,
  :job_tag)
  SENSITIVE = []
  include Aws::Structure
end