AmazonRekognitionClient.SearchUsersByImage Method (SearchUsersByImageRequest)

Searches for UserIDs using a supplied image. It first detects the largest face in the image, and then searches a specified collection for matching UserIDs.

The operation returns an array of UserIDs that match the face in the supplied image, ordered by similarity score with the highest similarity first. It also returns a bounding box for the face found in the input image.

Information about faces detected in the supplied image, but not used for the search, is returned in an array of UnsearchedFace objects. If no valid face is detected in the image, the response will contain an empty UserMatches list and no SearchedFace object.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to SearchUsersByImageAsync.

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

Syntax

public virtual SearchUsersByImageResponse SearchUsersByImage(
         SearchUsersByImageRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.SearchUsersByImageRequest

Container for the necessary parameters to execute the SearchUsersByImage service method.

Return Value

Type: SearchUsersByImageResponse

The response from the SearchUsersByImage service method, as returned by Rekognition.

Exceptions

Exception	Condition
AccessDeniedException	You are not authorized to perform the action.
ImageTooLargeException	The input image size exceeds the allowed limit. If you are calling DetectProtectiveEquipment, the image size or resolution exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
InternalServerErrorException	Amazon Rekognition experienced a service issue. Try your call again.
InvalidImageFormatException	The provided image format is not supported.
InvalidParameterException	Input parameter violated a constraint. Validate your parameter before calling the API operation again.
InvalidS3ObjectException	Amazon Rekognition is unable to access the S3 object specified in the request.
ProvisionedThroughputExceededException	The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceNotFoundException	The resource specified in the request cannot be found.
ThrottlingException	Amazon Rekognition is temporarily unable to process the request. Try your call again.

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 Framework:
Supported in: 4.5 and newer, 3.5

AmazonRekognitionClient.SearchUsersByImage (SearchUsersByImageRequest)

Method