Skip to content
AWS for Query.Farm

aws.rekognition.search_faces

Example SQL Queries

SELECT * FROM
aws.rekognition.search_faces
WHERE
"collection_id" = 'VALUE'
AND "face_id" = 'VALUE';

Description

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation 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 that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see Searching for a face using its face ID in the Amazon Rekognition Developer Guide.

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

Table Definition

Column NameColumn Data Type
collection_id Required Input Column

ID of the collection the face belongs to.

VARCHAR
face_id Required Input Column

ID of a face to find matches for in the collection.

VARCHAR
face_match_threshold Input Column

Optional value specifying 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
_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 matched 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_id

ID of the face that was searched for matches in a collection.

VARCHAR