ListFacesRequest Class | AWS SDK for .NET V3

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 Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

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

public class ListFacesRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The ListFacesRequest type exposes the following members

Constructors

	Name	Description
	ListFacesRequest()

Properties

Name	Type	Description
CollectionId	System.String	Gets and sets the property CollectionId. ID of the collection from which to list the faces.
FaceIds	System.Collections.Generic.List<System.String>	Gets and sets the property FaceIds. An array of face IDs to filter results with when listing faces in a collection.
MaxResults	System.Int32	Gets and sets the property MaxResults. Maximum number of faces to return.
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.
UserId	System.String	Gets and sets the property UserId. An array of user IDs to filter results with when listing faces in a collection.

Examples

This operation lists the faces in a Rekognition collection.

To list the faces in a collection


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

string faceModelVersion = response.FaceModelVersion;
List<Face> faces = response.Faces;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

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