✅ Link to the plugin page: undefined
Demo to preview the plugin:
✅ Live Demo:
✅ Bubble Editor: undefined
Introduction
AWS Rekognition Face Management Plugin. This plugin provides advanced face recognition and management capabilities using AWS Rekognition. It allows you to index faces, search for similar faces, manage biometric users, and administer AWS Rekognition collections.
How to setup Plugin Actions
Create Collection
“Create Collection” refers to the action within a software plugin or API that allows users to generate a new grouping or set of items for organization or manipulation.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
Create User
Create User -is an action in AWS Rekognition that allows the creation of a biometric user within a facial recognition collection. This user can have associated faces, enabling face-based identification and authentication.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
User Id | User ID is a unique identifier used to associate, manage, and search for a specific user within a face collection stored in AWS Rekognition. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
Error | Message error | Text |
Associate Faces
AWS Rekognition action that links one or more indexed faces to a specific user in a collection. This allows a user to be identified based on multiple face images.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
UserId | User ID is a unique identifier used to associate, manage, and search for a specific user within a face collection stored in AWS Rekognition. | Text |
FaceIds | Face ID is a unique identifier assigned to each face detected within an AWS Rekognition collection. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
User Status | User Status | Text |
Index Faces for Image List
an AWS Rekognition action that detects and stores faces from List of images in a specified collection. Each indexed face is assigned a unique
FaceId, which can later be used for face search, recognition, and authentication.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
AWS File or File Url | AWS File or File Url | Text |
Return Values:
Title | Description | Type |
Face Ids | TODO: Fill in description | Text |
Image Ids | TODO: Fill in description | Text |
Error | Message error | Text |
Search Faces By Image
an AWS Rekognition action that searches for matching faces in a specified collection by comparing an input image against previously indexed faces. It returns a list of Face IDs that match the face in the input image, along with similarity scores.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
File Url | File URL | Text |
Max Faces | When searching for faces (SearchFacesByImage), higher MaxFaces values can help retrieve more possible matches. | Number |
Face Match Threshold | A parameter in AWS Rekognition that sets the minimum similarity score required for a face to be considered a match. It is used in face search operations (SearchFacesByImage and SearchFaces) to filter out weak matches and return only the most confident results. | Number |
Return Values:
Title | Description | Type |
Face Ids | List of Faces ID found | Text |
Error | Message error | Text |
Describe Collection
is an AWS Rekognition action that retrieves metadata about a specified collection. This includes details such as the number of indexed faces, the Amazon Resource Name (ARN) of the collection, and the date it was created.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
Return Values:
Title | Description | Type |
Face Count | Number of faces indexed | Number |
Collection ARN | Collection ARN (Amazon Resource Name) | Text |
Disassociate Face
an AWS Rekognition action that removes the association between a face and a user in a collection. The face remains indexed in the collection, but it will no longer be linked to that specific user.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
UserId | User ID is a unique identifier used to associate, manage, and search for a specific user within a face collection stored in AWS Rekognition. | Text |
FaceIds | Face ID is a unique identifier assigned to each face detected within an AWS Rekognition collection. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
Delete Collection
an AWS Rekognition action that permanently deletes a specified face collection along with all indexed faces within it. Once deleted, the collection and its data cannot be recovered.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
Delete User
an AWS Rekognition action that permanently removes a user from a collection. This action does not delete the faces associated with the user—only the user entry itself. Any faces previously associated with the user remain indexed in the collection.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
User Id | User ID is a unique identifier used to associate, manage, and search for a specific user within a face collection stored in AWS Rekognition. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
Delete Faces
an AWS Rekognition action that removes specific faces from a collection. This action permanently deletes the selected faces, making them unavailable for future searches or authentication within that collection.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
FaceIds | Face ID is a unique identifier assigned to each face detected within an AWS Rekognition collection. | Text |
Return Values:
Title | Description | Type |
Status Code | Status Code is a number returned by a server in response to an HTTP or API request. It indicates the result of the operation performed, whether it was successful, an error, or another special condition.
200 OK → The operation was successfully completed.400 Bad Request → The request is invalid or has missing parameters. | Number |
Index Faces
an AWS Rekognition action that detects and stores faces from an image in a specified collection. Each indexed face is assigned a unique
FaceId, which can later be used for face search, recognition, and authentication.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
File URL | File URL | Text |
Return Values:
Title | Description | Type |
Face Ids | Unique identifier for the face | Text |
Image Ids | Unique identifier for the image | Text |
AgeRange | Estimated age range of the person | Text |
Emotions | Detected emotions (happy, sad, surprised, etc.). | Text |
Gender | Detected gender of the person. | Text |
Beard | Facial hair and eyewear detection. | Checkbox (yes/no) |
Eyeglasses | Facial hair and eyewear detection. | Checkbox (yes/no) |
Eyes Open | Face expressions and visibility. | Checkbox (yes/no) |
Face Occluded | Face expressions and visibility. | Checkbox (yes/no) |
Sunglasses | Facial hair and eyewear detection. | Checkbox (yes/no) |
Smile | Face expressions and visibility. | Checkbox (yes/no) |
ImageIds | Unique identifier for the image | Text |
Error | TODO: Fill in description | Text |
List Faces
an AWS Rekognition action that retrieves a list of all indexed faces in a specified collection. It allows developers to manage and review the stored facial data for recognition and authentication purposes.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
Max Results | MaxResults limits the number of items returned in a single AWS Rekognition API response. | Number |
Return Values:
Title | Description | Type |
Image Id | List of image id | Text |
Face Id | List of face id | Text |
List Users
an AWS Rekognition action that retrieves a list of all users in a specified collection. This allows developers to manage and review the users enrolled in facial recognition authentication systems.
Title | Description | Type |
Collection Name | Collection ID is a unique identifier used to create, manage, and search for faces within a face collection stored in AWS Rekognition. | Text |
Max Results | User ID is a unique identifier used to associate, manage, and search for a specific user within a face collection stored in AWS Rekognition. | Number |
Return Values:
Title | Description | Type |
User Name | List of users created in the collection | Text |
