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.

For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the IndexFaces operation. The operation compares the features of the input face with faces in the specified collection.

You can also search faces without indexing faces by using the SearchFacesByImage operation.

The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a confidence value for each face match, indicating the confidence that the specific face matches the input face.

For an example, see example3.

This operation requires permissions to perform the rekognition:SearchFaces action.

Note:

For PCL this operation is only available in asynchronous form. Please refer to SearchFacesAsync.

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

Syntax

C#
public virtual SearchFacesResponse SearchFaces(
         SearchFacesRequest request
)
Parameters
request
Type: Amazon.Rekognition.Model.SearchFacesRequest

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

Return Value
The response from the SearchFaces service method, as returned by Rekognition.

Exceptions

ExceptionCondition
AccessDeniedException You are not authorized to perform the action.
InternalServerErrorException Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException Input parameter violated a constraint. Validate your parameter before calling the API operation again.
ProvisionedThroughputExceededException The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceNotFoundException Collection specified in the request is not found.
ThrottlingException Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

This operation searches for matching faces in the collection the supplied face belongs to.

To delete a face


var response = client.DeleteFaces(new DeleteFacesRequest 
{
    CollectionId = "myphotos",
    FaceIds = new List {
        "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
    }
});

List deletedFaces = response.DeletedFaces;

            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also