The face collection is the resource used by Amazon Rekognition for containing information related to faces and users. You use various Rekognition API operations to manage the collection itself, as well as any faces or face vectors stored in the collection.
Managing a collection
The face collection is the primary Amazon Rekognition resource, and each face collection you create has a unique Amazon Resource Name (ARN). You create each face collection in a specific AWS Region in your account. When a collection is created, it's associated with the most recent version of the face detection model. For more information, see Understanding model versioning.
You can perform the following management operations on a collection:
-
Create a collection with CreateCollection. For more information, see Creating a collection.
-
List the available collections with ListCollections. For more information, see Listing collections.
-
Describe a collection with DescribeCollection. For more information, see Describing a collection.
-
Delete a collection with DeleteCollection. For more information, see Deleting a collection.
Managing faces in a collection
After you create a face collection, you can store faces in it. Amazon Rekognition provides the following operations for managing faces in a collection:
-
The IndexFaces operation detects faces in the input image (JPEG or PNG), and adds them to the specified face collection. A unique face ID is returned for each face that's detected in the image. After you persist faces, you can search the face collection for face matches. For more information, see Adding faces to a collection.
-
The ListFaces operation lists the faces in a collection. For more information, see Adding faces to a collection.
-
The DeleteFaces operation deletes faces from a collection. For more information, see Deleting faces from a collection.
Managing users in a collection
After you store multiple face vectors from the same person, you can improve accuracy by associating all of those face vectors into one user vector. You can use the following operations to manage your users:
-
CreateUser - Operation creates a new user in a collection with a provided unique user ID.
-
AssociateUsers - Add 1 - 100 unique face IDs to a user ID. After you associate at least one face ID to a user, you can search for matches against that user in your collection.
-
ListUsers - Lists the users in a collection.
-
DeleteUsers - Deletes a user from a collection with the provided user ID.
-
DisassociateFaces - Removes one or more face IDs from a user.
