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.

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.

Note:

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

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

Syntax

C#
public abstract DeleteFacesResponse DeleteFaces(
         DeleteFacesRequest request
)
Parameters
request
Type: Amazon.Rekognition.Model.DeleteFacesRequest

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

Return Value
The response from the DeleteFaces 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.
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 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 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