Skip to content
AWS for Query.Farm

aws.rekognition.search_faces_by_image

Example SQL Queries

SELECT * FROM
aws.rekognition.search_faces_by_image
WHERE
"collection_id" = 'VALUE'
AND "image" = 'VALUE';

Description

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection.

To search for all faces in an input image, you might first call the IndexFaces operation, and then use the face IDs returned in subsequent calls to the SearchFaces operation.

You can also call the DetectFaces operation and use the bounding boxes in the response to make face crops, which then you can pass in to the SearchFacesByImage operation.

You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file.

The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a similarity indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image.

If no faces are detected in the input image, SearchFacesByImage returns an InvalidParameterException error.

For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide.

The QualityFilter input parameter allows you to filter out detected faces that don’t meet a required quality bar. The quality bar is based on a variety of common use cases. Use QualityFilter to set the quality bar for filtering by specifying LOW, MEDIUM, or HIGH. If you do not want to filter detected faces, specify NONE. The default value is NONE.

To use quality filtering, you need a collection associated with version 3 of the face model or higher. To get the version of the face model associated with a collection, call DescribeCollection.

This operation requires permissions to perform the rekognition:SearchFacesByImage action.

Table Definition

Column NameColumn Data Type
collection_id Required Input Column

ID of the collection to search.

VARCHAR
image Required Input Column

The input image as base64-encoded bytes or an S3 object. If you use the AWS CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is not supported.

If you are using an AWS SDK to call Amazon Rekognition, you might not need to base64-encode image bytes passed using the Bytes field. For more information, see Images in the Amazon Rekognition developer guide.

STRUCT(
    "bytes" BLOB,
    "s3_object" STRUCT(
        "bucket" VARCHAR,
        "name" VARCHAR,
        "version" VARCHAR
    )
)
Show child fields
image.bytes

Blob of image bytes up to 5 MBs. Note that the maximum image size you can pass to DetectCustomLabels is 4MB.

image.s3_object

Identifies an S3 object as the image source.

Show child fields
image.s3_object.bucket

Name of the S3 bucket.

image.s3_object.name

S3 object key name.

image.s3_object.version

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

face_match_threshold Input Column

(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.

DOUBLE
max_faces Input Column

Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.

BIGINT
quality_filter Input Column

A filter that specifies a quality bar for how much filtering is done to identify faces. Filtered faces aren't searched for in the collection. If you specify AUTO, Amazon Rekognition chooses the quality bar. If you specify LOW, MEDIUM, or HIGH, filtering removes all faces that don’t meet the chosen quality bar. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify NONE, no filtering is performed. The default value is NONE.

To use quality filtering, the collection you are using must be associated with version 3 of the face model or higher.

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
face_matches

An array of faces that match the input face, along with the confidence in the match.

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
face_matches[]
Show child fields
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
face_matches[].face.bounding_box

Bounding box of the face.

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

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

face_matches[].face.bounding_box.left

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

face_matches[].face.bounding_box.top

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

face_matches[].face.bounding_box.width

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

face_matches[].face.confidence

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

face_matches[].face.external_image_id

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

face_matches[].face.face_id

Unique identifier that Amazon Rekognition assigns to the face.

face_matches[].face.image_id

Unique identifier that Amazon Rekognition assigns to the input image.

face_matches[].face.index_faces_model_version

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

face_matches[].face.user_id

Unique identifier assigned to the user.

face_matches[].similarity

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

face_model_version

Version number of the face detection model associated with the input collection (CollectionId).

VARCHAR
searched_face_bounding_box

The bounding box around the face in the input image that Amazon Rekognition used for the search.

STRUCT(
    "width" DOUBLE,
    "height" DOUBLE,
    "left" DOUBLE,
    "top" DOUBLE
)
Show child fields
searched_face_bounding_box.height

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

searched_face_bounding_box.left

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

searched_face_bounding_box.top

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

searched_face_bounding_box.width

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

searched_face_confidence

The level of confidence that the searchedFaceBoundingBox, contains a face.

DOUBLE