AmazonRekognitionClient.DeleteFaces Method (DeleteFacesRequest)

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 .NET Core 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

public virtual DeleteFacesResponse DeleteFaces(
         DeleteFacesRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.DeleteFacesRequest

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

Return Value

Type: DeleteFacesResponse

The response from the DeleteFaces service method, as returned by Rekognition.

Exceptions

Exception	Condition
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	The resource specified in the request cannot be 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 client = new AmazonRekognitionClient();
var response = client.DeleteFaces(new DeleteFacesRequest 
{
    CollectionId = "myphotos",
    FaceIds = new List<string> {
        "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
    }
});

List<string> deletedFaces = response.DeletedFaces;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonRekognitionClient.DeleteFaces (DeleteFacesRequest)

Method