Associate Faces
rekognition_associate_faces | R Documentation |
Associates one or more faces with an existing UserID¶
Description¶
Associates one or more faces with an existing UserID. Takes an array of
FaceIds
. Each FaceId
that are present in the FaceIds
list is
associated with the provided UserID. The maximum number of total
FaceIds
per UserID is 100.
The UserMatchThreshold
parameter specifies the minimum user match
confidence required for the face to be associated with a UserID that has
at least one FaceID
already associated. This ensures that the
FaceIds
are associated with the right UserID. The value ranges from
0-100 and default value is 75.
If successful, an array of AssociatedFace
objects containing the
associated FaceIds
is returned. If a given face is already associated
with the given UserID
, it will be ignored and will not be returned in
the response. If a given face is already associated to a different
UserID
, isn't found in the collection, doesn’t meet the
UserMatchThreshold
, or there are already 100 faces associated with the
UserID
, it will be returned as part of an array of
UnsuccessfulFaceAssociations.
The UserStatus
reflects the status of an operation which updates a
UserID representation with a list of given faces. The UserStatus
can
be:
-
ACTIVE - All associations or disassociations of FaceID(s) for a UserID are complete.
-
CREATED - A UserID has been created, but has no FaceID(s) associated with it.
-
UPDATING - A UserID is being updated and there are current associations or disassociations of FaceID(s) taking place.
Usage¶
Arguments¶
CollectionId
[required] The ID of an existing collection containing the UserID.
UserId
[required] The ID for the existing UserID.
FaceIds
[required] An array of FaceIDs to associate with the UserID.
UserMatchThreshold
An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.
ClientRequestToken
Idempotent token used to identify the request to
associate_faces
. If you use the same token with multipleassociate_faces
requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.
Value¶
A list with the following syntax:
list(
AssociatedFaces = list(
list(
FaceId = "string"
)
),
UnsuccessfulFaceAssociations = list(
list(
FaceId = "string",
UserId = "string",
Confidence = 123.0,
Reasons = list(
"FACE_NOT_FOUND"|"ASSOCIATED_TO_A_DIFFERENT_USER"|"LOW_MATCH_CONFIDENCE"
)
)
),
UserStatus = "ACTIVE"|"UPDATING"|"CREATING"|"CREATED"
)
Request syntax¶
svc$associate_faces(
CollectionId = "string",
UserId = "string",
FaceIds = list(
"string"
),
UserMatchThreshold = 123.0,
ClientRequestToken = "string"
)
Examples¶
## Not run:
# This operation associates one or more faces with an existing UserID.
svc$associate_faces(
ClientRequestToken = "550e8400-e29b-41d4-a716-446655440002",
CollectionId = "MyCollection",
FaceIds = list(
"f5817d37-94f6-4335-bfee-6cf79a3d806e",
"851cb847-dccc-4fea-9309-9f4805967855",
"35ebbb41-7f67-4263-908d-dd0ecba05ab9"
),
UserId = "DemoUser",
UserMatchThreshold = 70L
)
## End(Not run)