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 DeleteFaces operation. Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection.

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

Inheritance Hierarchy

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

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

Syntax

C#
public class DeleteFacesRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The DeleteFacesRequest type exposes the following members

Constructors

NameDescription
Public Method DeleteFacesRequest()

Properties

NameTypeDescription
Public Property CollectionId System.String

Gets and sets the property CollectionId.

Collection from which to remove the specific faces.

Public Property FaceIds System.Collections.Generic.List<System.String>

Gets and sets the property FaceIds.

An array of face IDs to delete.

Examples

This operation deletes one or more faces from a Rekognition collection.

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 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