class Aws::Rekognition::Types::StartFaceSearchRequest
@note When making an API call, you may pass StartFaceSearchRequest
data as a hash: { video: { # required s3_object: { bucket: "S3Bucket", name: "S3ObjectName", version: "S3ObjectVersion", }, }, client_request_token: "ClientRequestToken", face_match_threshold: 1.0, collection_id: "CollectionId", # required notification_channel: { sns_topic_arn: "SNSTopicArn", # required role_arn: "RoleArn", # required }, job_tag: "JobTag", }
@!attribute [rw] video
The video you want to search. The video must be stored in an Amazon S3 bucket. @return [Types::Video]
@!attribute [rw] client_request_token
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. @return [String]
@!attribute [rw] face_match_threshold
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%. @return [Float]
@!attribute [rw] collection_id
ID of the collection that contains the faces you want to search for. @return [String]
@!attribute [rw] notification_channel
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. @return [Types::NotificationChannel]
@!attribute [rw] job_tag
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. @return [String]
Constants
- SENSITIVE