Skip to content
AWS for Query.Farm

aws.rekognition.search_users

Example SQL Queries

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

Description

Searches for UserIDs within a collection based on a FaceId or UserId. This API can be used to find the closest UserID (with a highest similarity) to associate a face. The request must be provided with either FaceId or UserId. The operation returns an array of UserID that match the FaceId or UserId, ordered by similarity score with the highest similarity first.

Table Definition

Column NameColumn Data Type
collection_id Required Input Column

The ID of an existing collection containing the UserID, used with a UserId or FaceId. If a FaceId is provided, UserId isn’t required to be present in the Collection.

VARCHAR
face_id Input Column

ID for the existing face.

VARCHAR
max_users Input Column

Maximum number of identities to return.

BIGINT
user_id Input Column

ID for the existing User.

VARCHAR
user_match_threshold Input Column

Optional value that specifies the minimum confidence in the matched UserID to return. Default value of 80.

DOUBLE
_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 CollectionId.

VARCHAR
searched_face

Contains the ID of a face that was used to search for matches in a collection.

STRUCT(
    "face_id" VARCHAR
)
Show child fields
searched_face.face_id

Unique identifier assigned to the face.

searched_user

Contains the ID of the UserID that was used to search for matches in a collection.

STRUCT(
    "user_id" VARCHAR
)
Show child fields
searched_user.user_id

A provided ID for the UserID. Unique within the collection.

user_matches

An array of UserMatch objects that matched the input face along with the confidence in the match. Array will be empty if there are no matches.

STRUCT(
    "similarity" DOUBLE,
    "user" STRUCT(
        "user_id" VARCHAR,
        "user_status" VARCHAR
    )
)[]
Show child fields
user_matches[]
Show child fields
user_matches[].similarity

Describes the UserID metadata.

user_matches[].user

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

Show child fields
user_matches[].user.user_id

A provided ID for the UserID. Unique within the collection.

user_matches[].user.user_status

The status of the user matched to a provided FaceID.