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.

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see example3.

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

Note:

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

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

Syntax

C#
public virtual ListFacesResponse ListFaces(
         ListFacesRequest request
)
Parameters
request
Type: Amazon.Rekognition.Model.ListFacesRequest

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

Return Value
The response from the ListFaces 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.
InvalidPaginationTokenException Pagination token in the request is not valid.
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 lists the faces in a Rekognition collection.

To list the faces in a collection


var response = client.ListFaces(new ListFacesRequest 
{
    CollectionId = "myphotos",
    MaxResults = 20
});

List faces = response.Faces;

            

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