AWSRekognitionStartFaceSearchRequest

Objective-C

@interface AWSRekognitionStartFaceSearchRequest

Swift

class AWSRekognitionStartFaceSearchRequest

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable clientRequestToken;

    Swift

    var clientRequestToken: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable collectionId;

    Swift

    var collectionId: String? { get set }

  • 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%.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable faceMatchThreshold;

    Swift

    var faceMatchThreshold: NSNumber? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobTag;

    Swift

    var jobTag: String? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSRekognitionNotificationChannel *_Nullable notificationChannel;

    Swift

    var notificationChannel: AWSRekognitionNotificationChannel? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSRekognitionVideo *_Nullable video;

    Swift

    var video: AWSRekognitionVideo? { get set }