/AWS1/CL_REK=>ASSOCIATEFACES()
¶
About AssociateFaces¶
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.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_COLLECTIONID
TYPE /AWS1/REKCOLLECTIONID
/AWS1/REKCOLLECTIONID
¶
The ID of an existing collection containing the UserID.
IV_USERID
TYPE /AWS1/REKUSERID
/AWS1/REKUSERID
¶
The ID for the existing UserID.
IT_FACEIDS
TYPE /AWS1/CL_REKUSERFACEIDLIST_W=>TT_USERFACEIDLIST
TT_USERFACEIDLIST
¶
An array of FaceIDs to associate with the UserID.
Optional arguments:¶
IV_USERMATCHTHRESHOLD
TYPE /AWS1/RT_FLOAT_AS_STRING
/AWS1/RT_FLOAT_AS_STRING
¶
An optional value specifying the minimum confidence in the UserID match to return. The default value is 75.
IV_CLIENTREQUESTTOKEN
TYPE /AWS1/REKCLIENTREQUESTTOKEN
/AWS1/REKCLIENTREQUESTTOKEN
¶
Idempotent token used to identify the request to
AssociateFaces
. If you use the same token with multipleAssociateFaces
requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.