Delete Faces

rekognition_delete_faces

R Documentation

Deletes faces from a collection¶

Description¶

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.

Usage¶

rekognition_delete_faces(CollectionId, FaceIds)

Arguments¶

CollectionId: [required] Collection from which to remove the specific faces.
FaceIds: [required] An array of face IDs to delete.

Value¶

A list with the following syntax:

list(
  DeletedFaces = list(
    "string"
  ),
  UnsuccessfulFaceDeletions = list(
    list(
      FaceId = "string",
      UserId = "string",
      Reasons = list(
        "ASSOCIATED_TO_AN_EXISTING_USER"|"FACE_NOT_FOUND"
      )
    )
  )
)

Request syntax¶

svc$delete_faces(
  CollectionId = "string",
  FaceIds = list(
    "string"
  )
)

Examples¶

## Not run: 
# This operation deletes one or more faces from a Rekognition collection.
svc$delete_faces(
  CollectionId = "myphotos",
  FaceIds = list(
    "ff43d742-0c13-5d16-a3e8-03d3f58e980b"
  )
)

## End(Not run)