AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the SearchUsersByImage operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Rekognition.Model.SearchUsersByImageResponse

Namespace: Amazon.Rekognition.Model
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

C#
public class SearchUsersByImageResponse : AmazonWebServiceResponse

The SearchUsersByImageResponse type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property FaceModelVersion System.String

Gets and sets the property FaceModelVersion.

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

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property SearchedFace Amazon.Rekognition.Model.SearchedFaceDetails

Gets and sets the property SearchedFace.

A list of FaceDetail objects containing the BoundingBox for the largest face in image, as well as the confidence in the bounding box, that was searched for matches. If no valid face is detected in the image the response will contain no SearchedFace object.

Public Property UnsearchedFaces System.Collections.Generic.List<Amazon.Rekognition.Model.UnsearchedFace>

Gets and sets the property UnsearchedFaces.

List of UnsearchedFace objects. Contains the face details infered from the specified image but not used for search. Contains reasons that describe why a face wasn't used for Search.

Public Property UserMatches System.Collections.Generic.List<Amazon.Rekognition.Model.UserMatch>

Gets and sets the property UserMatches.

An array of UserID objects that matched the input face, along with the confidence in the match. The returned structure will be empty if there are no matches. Returned if the SearchUsersByImageResponse action is successful.

Examples

Searches for UserIDs using a supplied image.

SearchUsersByImage


var client = new AmazonRekognitionClient();
var response = client.SearchUsersByImage(new SearchUsersByImageRequest 
{
    CollectionId = "MyCollection",
    Image = new Image { S3Object = new S3Object {
        Bucket = "bucket",
        Name = "input.jpg"
    } },
    MaxUsers = 2,
    QualityFilter = "MEDIUM",
    UserMatchThreshold = 70
});

string faceModelVersion = response.FaceModelVersion;
SearchedFaceDetails searchedFace = response.SearchedFace;
List<UnsearchedFace> unsearchedFaces = response.UnsearchedFaces;
List<UserMatch> userMatches = response.UserMatches;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5