Interface SearchUsersCommandOutput

The output of SearchUsersCommand.

interface SearchUsersCommandOutput {
    $metadata: ResponseMetadata;
    FaceModelVersion?: string;
    SearchedFace?: SearchedFace;
    SearchedUser?: SearchedUser;
    UserMatches?: UserMatch[];
}

Hierarchy (view full)

Properties

$metadata FaceModelVersion? SearchedFace? SearchedUser? UserMatches?

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional FaceModelVersion

FaceModelVersion?: string

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

Optional SearchedFace

SearchedFace?: SearchedFace

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

Optional SearchedUser

SearchedUser?: SearchedUser

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

Optional UserMatches

UserMatches?: UserMatch[]

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.

Settings

Member Visibility

Theme

On This Page