Skip to content
AWS for Query.Farm

aws.rekognition.list_faces

Example SQL Queries

SELECT * FROM
aws.rekognition.list_faces
WHERE
"collection_id" = 'VALUE';

Description

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

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

Table Definition

Column NameColumn Data Type
collection_id Required Input Column

ID of the collection from which to list the faces.

VARCHAR
face_ids Input Column

An array of face IDs to filter results with when listing faces in a collection.

VARCHAR[]
Show child fields
face_ids[]
user_id Input Column

An array of user IDs to filter results with when listing faces in a collection.

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_model_version

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

VARCHAR
faces

An array of Face objects. 

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

Bounding box of the face.

Show child fields
faces[].bounding_box.height

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

faces[].bounding_box.left

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

faces[].bounding_box.top

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

faces[].bounding_box.width

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

faces[].confidence

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

faces[].external_image_id

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

faces[].face_id

Unique identifier that Amazon Rekognition assigns to the face.

faces[].image_id

Unique identifier that Amazon Rekognition assigns to the input image.

faces[].index_faces_model_version

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

faces[].user_id

Unique identifier assigned to the user.