StartFaceSearchRequest

public struct StartFaceSearchRequest : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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

    Swift

    public let clientRequestToken: String?

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

    Declaration

    Swift

    public let collectionId: String

  • 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

    Swift

    public let faceMatchThreshold: Float?

  • 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

    Swift

    public let jobTag: String?

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

    Declaration

    Swift

    public let notificationChannel: NotificationChannel?

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

    Declaration

    Swift

    public let video: Video

  • Undocumented

    Declaration

    Swift

    public init(clientRequestToken: String? = nil, collectionId: String, faceMatchThreshold: Float? = nil, jobTag: String? = nil, notificationChannel: NotificationChannel? = nil, video: Video)

  • Declaration

    Swift

    public func validate(name: String) throws