Skip to content
AWS for Query.Farm

aws.rekognition.get_face_search

Example SQL Queries

SELECT * FROM
aws.rekognition.get_face_search
WHERE
"job_id" = 'VALUE';

Description

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video.

Face search in a video is an asynchronous operation. You start face search by calling to StartFaceSearch which returns a job identifier (JobId). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to StartFaceSearch. To get the search results, first check that the status value published to the Amazon SNS topic is SUCCEEDED. If so, call GetFaceSearch and pass the job identifier (JobId) from the initial call to StartFaceSearch.

For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide.

The search results are retured in an array, Persons, of PersonMatch objects. EachPersonMatch element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video.

GetFaceSearch only returns the default facial attributes (BoundingBox, Confidence, Landmarks, Pose, and Quality). The other facial attributes listed in the Face object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide.

By default, the Persons array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying INDEX for the SORTBY input parameter.

Table Definition

Column NameColumn Data Type
job_id Required Input Column

Job identifier for the face search operation for which you want to obtain results. The job identifer is returned by an initial call to StartFaceSearch.

VARCHAR
max_results Input Column

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

BIGINT
next_token Input Column

If the response is truncated, Amazon Rekognition Video returns this token that you can use in the subsequent request to retrieve the next set of search results. 

VARCHAR
sort_by Input Column

Sort to use for grouping faces in the response. Use TIMESTAMP to group faces by the time that they are recognized. Use INDEX to sort by recognized faces. 

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
job_status

The current status of the face search job.

VARCHAR
job_tag

A job identifier specified in the call to StartFaceSearch and returned in the job completion notification sent to your Amazon Simple Notification Service topic.

VARCHAR
persons

An array of persons, PersonMatch, in the video whose face(s) match the face(s) in an Amazon Rekognition collection. It also includes time information for when persons are matched in the video. You specify the input collection in an initial call to StartFaceSearch. Each Persons element includes a time the person was matched, face match details (FaceMatches) for matching faces in the collection, and person information (Person) for the matched person. 

STRUCT(
    "timestamp" BIGINT,
    "person" STRUCT(
        "index" BIGINT,
        "bounding_box" STRUCT(
            "width" DOUBLE,
            "height" DOUBLE,
            "left" DOUBLE,
            "top" DOUBLE
        ),
        "face" STRUCT(
            "bounding_box" STRUCT(
                "width" DOUBLE,
                "height" DOUBLE,
                "left" DOUBLE,
                "top" DOUBLE
            ),
            "age_range" STRUCT(
                "low" BIGINT,
                "high" BIGINT
            ),
            "smile" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "eyeglasses" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "sunglasses" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "gender" STRUCT(
                "value" VARCHAR,
                "confidence" DOUBLE
            ),
            "beard" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "mustache" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "eyes_open" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "mouth_open" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "emotions" STRUCT(
                "type" VARCHAR,
                "confidence" DOUBLE
            )[],
            "landmarks" STRUCT(
                "type" VARCHAR,
                "x" DOUBLE,
                "y" DOUBLE
            )[],
            "pose" STRUCT(
                "roll" DOUBLE,
                "yaw" DOUBLE,
                "pitch" DOUBLE
            ),
            "quality" STRUCT(
                "brightness" DOUBLE,
                "sharpness" DOUBLE
            ),
            "confidence" DOUBLE,
            "face_occluded" STRUCT(
                "value" BOOLEAN,
                "confidence" DOUBLE
            ),
            "eye_direction" STRUCT(
                "yaw" DOUBLE,
                "pitch" DOUBLE,
                "confidence" DOUBLE
            )
        )
    ),
    "face_matches" STRUCT(
        "similarity" DOUBLE,
        "face" STRUCT(
            "face_id" VARCHAR,
            "bounding_box" STRUCT(
                "width" DOUBLE,
                "height" DOUBLE,
                "left" DOUBLE,
                "top" DOUBLE
            ),
            "image_id" VARCHAR,
            "external_image_id" VARCHAR,
            "confidence" DOUBLE,
            "index_faces_model_version" VARCHAR,
            "user_id" VARCHAR
        )
    )[]
)[]
Show child fields
persons[]
Show child fields
persons[].face_matches[]
Show child fields
persons[].face_matches[].face

Describes the face properties such as the bounding box, face ID, image ID of the source image, and external image ID that you assigned.

Show child fields
persons[].face_matches[].face.bounding_box

Bounding box of the face.

Show child fields
persons[].face_matches[].face.bounding_box.height

Height of the bounding box as a ratio of the overall image height.

persons[].face_matches[].face.bounding_box.left

Left coordinate of the bounding box as a ratio of overall image width.

persons[].face_matches[].face.bounding_box.top

Top coordinate of the bounding box as a ratio of overall image height.

persons[].face_matches[].face.bounding_box.width

Width of the bounding box as a ratio of the overall image width.

persons[].face_matches[].face.confidence

Confidence level that the bounding box contains a face (and not a different object such as a tree).

persons[].face_matches[].face.external_image_id

Identifier that you assign to all the faces in the input image.

persons[].face_matches[].face.face_id

Unique identifier that Amazon Rekognition assigns to the face.

persons[].face_matches[].face.image_id

Unique identifier that Amazon Rekognition assigns to the input image.

persons[].face_matches[].face.index_faces_model_version

The version of the face detect and storage model that was used when indexing the face vector.

persons[].face_matches[].face.user_id

Unique identifier assigned to the user.

persons[].face_matches[].similarity

Confidence in the match of this face with the input face.

persons[].person

Information about the matched person.

Show child fields
persons[].person.bounding_box

Bounding box around the detected person.

Show child fields
persons[].person.bounding_box.height

Height of the bounding box as a ratio of the overall image height.

persons[].person.bounding_box.left

Left coordinate of the bounding box as a ratio of overall image width.

persons[].person.bounding_box.top

Top coordinate of the bounding box as a ratio of overall image height.

persons[].person.bounding_box.width

Width of the bounding box as a ratio of the overall image width.

persons[].person.face

Face details for the detected person.

Show child fields
persons[].person.face.age_range

The estimated age range, in years, for the face. Low represents the lowest estimated age and High represents the highest estimated age.

Show child fields
persons[].person.face.age_range.high

The highest estimated age.

persons[].person.face.age_range.low

The lowest estimated age.

persons[].person.face.beard

Indicates whether or not the face has a beard, and the confidence level in the determination.

Show child fields
persons[].person.face.beard.confidence

Level of confidence in the determination.

persons[].person.face.beard.value

Boolean value that indicates whether the face has beard or not.

persons[].person.face.bounding_box

Bounding box of the face. Default attribute.

Show child fields
persons[].person.face.bounding_box.height

Height of the bounding box as a ratio of the overall image height.

persons[].person.face.bounding_box.left

Left coordinate of the bounding box as a ratio of overall image width.

persons[].person.face.bounding_box.top

Top coordinate of the bounding box as a ratio of overall image height.

persons[].person.face.bounding_box.width

Width of the bounding box as a ratio of the overall image width.

persons[].person.face.confidence

Confidence level that the bounding box contains a face (and not a different object such as a tree). Default attribute.

persons[].person.face.emotions[]
Show child fields
persons[].person.face.emotions[].confidence

Level of confidence in the determination.

persons[].person.face.emotions[].type

Type of emotion detected.

persons[].person.face.eye_direction

Indicates the direction the eyes are gazing in, as defined by pitch and yaw.

Show child fields
persons[].person.face.eye_direction.confidence

The confidence that the service has in its predicted eye direction.

persons[].person.face.eye_direction.pitch

Value representing eye direction on the pitch axis.

persons[].person.face.eye_direction.yaw

Value representing eye direction on the yaw axis.

persons[].person.face.eyeglasses

Indicates whether or not the face is wearing eye glasses, and the confidence level in the determination.

Show child fields
persons[].person.face.eyeglasses.confidence

Level of confidence in the determination.

persons[].person.face.eyeglasses.value

Boolean value that indicates whether the face is wearing eye glasses or not.

persons[].person.face.eyes_open

Indicates whether or not the eyes on the face are open, and the confidence level in the determination.

Show child fields
persons[].person.face.eyes_open.confidence

Level of confidence in the determination.

persons[].person.face.eyes_open.value

Boolean value that indicates whether the eyes on the face are open.

persons[].person.face.face_occluded

FaceOccluded should return "true" with a high confidence score if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. FaceOccluded should return "false" with a high confidence score if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.

Show child fields
persons[].person.face.face_occluded.confidence

The confidence that the service has detected the presence of a face occlusion.

persons[].person.face.face_occluded.value

True if a detected face’s eyes, nose, and mouth are partially captured or if they are covered by masks, dark sunglasses, cell phones, hands, or other objects. False if common occurrences that do not impact face verification are detected, such as eye glasses, lightly tinted sunglasses, strands of hair, and others.

persons[].person.face.gender

The predicted gender of a detected face.

Show child fields
persons[].person.face.gender.confidence

Level of confidence in the prediction.

persons[].person.face.gender.value

The predicted gender of the face.

persons[].person.face.landmarks[]
Show child fields
persons[].person.face.landmarks[].type

Type of landmark.

persons[].person.face.landmarks[].x

The x-coordinate of the landmark expressed as a ratio of the width of the image. The x-coordinate is measured from the left-side of the image. For example, if the image is 700 pixels wide and the x-coordinate of the landmark is at 350 pixels, this value is 0.5.

persons[].person.face.landmarks[].y

The y-coordinate of the landmark expressed as a ratio of the height of the image. The y-coordinate is measured from the top of the image. For example, if the image height is 200 pixels and the y-coordinate of the landmark is at 50 pixels, this value is 0.25.

persons[].person.face.mouth_open

Indicates whether or not the mouth on the face is open, and the confidence level in the determination.

Show child fields
persons[].person.face.mouth_open.confidence

Level of confidence in the determination.

persons[].person.face.mouth_open.value

Boolean value that indicates whether the mouth on the face is open or not.

persons[].person.face.mustache

Indicates whether or not the face has a mustache, and the confidence level in the determination.

Show child fields
persons[].person.face.mustache.confidence

Level of confidence in the determination.

persons[].person.face.mustache.value

Boolean value that indicates whether the face has mustache or not.

persons[].person.face.pose

Indicates the pose of the face as determined by its pitch, roll, and yaw. Default attribute.

Show child fields
persons[].person.face.pose.pitch

Value representing the face rotation on the pitch axis.

persons[].person.face.pose.roll

Value representing the face rotation on the roll axis.

persons[].person.face.pose.yaw

Value representing the face rotation on the yaw axis.

persons[].person.face.quality

Identifies image brightness and sharpness. Default attribute.

Show child fields
persons[].person.face.quality.brightness

Value representing brightness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a brighter face image.

persons[].person.face.quality.sharpness

Value representing sharpness of the face. The service returns a value between 0 and 100 (inclusive). A higher value indicates a sharper face image.

persons[].person.face.smile

Indicates whether or not the face is smiling, and the confidence level in the determination.

Show child fields
persons[].person.face.smile.confidence

Level of confidence in the determination.

persons[].person.face.smile.value

Boolean value that indicates whether the face is smiling or not.

persons[].person.face.sunglasses

Indicates whether or not the face is wearing sunglasses, and the confidence level in the determination.

Show child fields
persons[].person.face.sunglasses.confidence

Level of confidence in the determination.

persons[].person.face.sunglasses.value

Boolean value that indicates whether the face is wearing sunglasses or not.

persons[].person.index

Identifier for the person detected person within a video. Use to keep track of the person throughout the video. The identifier is not stored by Amazon Rekognition.

persons[].timestamp

The time, in milliseconds from the beginning of the video, that the person was matched in the video.

status_message

If the job fails, StatusMessage provides a descriptive error message.

VARCHAR
video

Video file stored in an Amazon S3 bucket. Amazon Rekognition video start operations such as StartLabelDetection use Video to specify a video for analysis. The supported file formats are .mp4, .mov and .avi.

STRUCT(
    "s3_object" STRUCT(
        "bucket" VARCHAR,
        "name" VARCHAR,
        "version" VARCHAR
    )
)
Show child fields
video.s3_object

The Amazon S3 bucket name and file name for the video.

Show child fields
video.s3_object.bucket

Name of the S3 bucket.

video.s3_object.name

S3 object key name.

video.s3_object.version

If the bucket is versioning enabled, you can specify the object version.

video_metadata

Information about a video that Amazon Rekognition analyzed. Videometadata is returned in every page of paginated responses from a Amazon Rekognition Video operation. 

STRUCT(
    "codec" VARCHAR,
    "duration_millis" BIGINT,
    "format" VARCHAR,
    "frame_rate" DOUBLE,
    "frame_height" BIGINT,
    "frame_width" BIGINT,
    "color_range" VARCHAR
)
Show child fields
video_metadata.codec

Type of compression used in the analyzed video.

video_metadata.color_range

A description of the range of luminance values in a video, either LIMITED (16 to 235) or FULL (0 to 255).

video_metadata.duration_millis

Length of the video in milliseconds.

video_metadata.format

Format of the analyzed video. Possible values are MP4, MOV and AVI.

video_metadata.frame_height

Vertical pixel dimension of the video.

video_metadata.frame_rate

Number of frames per second in the video.

video_metadata.frame_width

Horizontal pixel dimension of the video.