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.

Container for the parameters to the ListFaces operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.ListFacesRequest

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

Syntax

C#
public class ListFacesRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The ListFacesRequest type exposes the following members

Constructors

NameDescription
Public Method ListFacesRequest()

Properties

NameTypeDescription
Public Property CollectionId System.String

Gets and sets the property CollectionId.

ID of the collection from which to list the faces.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

Maximum number of faces to return.

Public Property NextToken System.String

Gets and sets the property NextToken.

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

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 Standard:
Supported in: 1.3

.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