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 Searching for a face using its face ID in the Amazon Rekognition Developer Guide.
This operation requires permissions to perform the rekognition:SearchFaces
action.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginSearchFaces and EndSearchFaces.
Namespace: Amazon.Rekognition
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z
public virtual Task<SearchFacesResponse> SearchFacesAsync( SearchFacesRequest request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the SearchFaces service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| 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 | The resource specified in the request cannot be found. |
| ThrottlingException | Amazon Rekognition is temporarily unable to process the request. Try your call again. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5