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 SearchUsers operation.

Inheritance Hierarchy

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

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

Syntax

C#
public class SearchUsersResponse : AmazonWebServiceResponse

The SearchUsersResponse type exposes the following members

Constructors

NameDescription
Public Method SearchUsersResponse()

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 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.SearchedFace

Gets and sets the property SearchedFace.

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

Public Property SearchedUser Amazon.Rekognition.Model.SearchedUser

Gets and sets the property SearchedUser.

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

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

Gets and sets the property UserMatches.

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.

Examples

Searches for UserIDs within a collection based on a FaceId or UserId.

SearchUsers


var client = new AmazonRekognitionClient();
var response = client.SearchUsers(new SearchUsersRequest 
{
    CollectionId = "MyCollection",
    MaxUsers = 2,
    UserId = "DemoUser",
    UserMatchThreshold = 70
});

string faceModelVersion = response.FaceModelVersion;
SearchedUser searchedUser = response.SearchedUser;
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