Disassociate Faces
rekognition_disassociate_faces | R Documentation |
Removes the association between a Face supplied in an array of FaceIds and the User¶
Description¶
Removes the association between a Face
supplied in an array of
FaceIds
and the User. If the User is not present already, then a
ResourceNotFound
exception is thrown. If successful, an array of faces
that are disassociated from the User is returned. If a given face is
already disassociated from the given UserID, it will be ignored and not
be returned in the response. If a given face is already associated with
a different User or not found in the collection it will be returned as
part of UnsuccessfulDisassociations
. You can remove 1 - 100 face IDs
from a user at one time.
Usage¶
Arguments¶
CollectionId
[required] The ID of an existing collection containing the UserID.
UserId
[required] ID for the existing UserID.
ClientRequestToken
Idempotent token used to identify the request to
disassociate_faces
. If you use the same token with multipledisassociate_faces
requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.FaceIds
[required] An array of face IDs to disassociate from the UserID.
Value¶
A list with the following syntax:
list(
DisassociatedFaces = list(
list(
FaceId = "string"
)
),
UnsuccessfulFaceDisassociations = list(
list(
FaceId = "string",
UserId = "string",
Reasons = list(
"FACE_NOT_FOUND"|"ASSOCIATED_TO_A_DIFFERENT_USER"
)
)
),
UserStatus = "ACTIVE"|"UPDATING"|"CREATING"|"CREATED"
)
Request syntax¶
svc$disassociate_faces(
CollectionId = "string",
UserId = "string",
ClientRequestToken = "string",
FaceIds = list(
"string"
)
)
Examples¶
## Not run:
# Removes the association between a Face supplied in an array of FaceIds
# and the User.
svc$disassociate_faces(
ClientRequestToken = "550e8400-e29b-41d4-a716-446655440003",
CollectionId = "MyCollection",
FaceIds = list(
"f5817d37-94f6-4335-bfee-6cf79a3d806e",
"c92265d4-5f9c-43af-a58e-12be0ce02bc3"
),
UserId = "DemoUser"
)
## End(Not run)