Delete User
rekognition_delete_user | R Documentation |
Deletes the specified UserID within the collection¶
Description¶
Deletes the specified UserID within the collection. Faces that are
associated with the UserID are disassociated from the UserID before
deleting the specified UserID. If the specified Collection
or UserID
is already deleted or not found, a ResourceNotFoundException
will be
thrown. If the action is successful with a 200 response, an empty HTTP
body is returned.
Usage¶
rekognition_delete_user(CollectionId, UserId, ClientRequestToken)
Arguments¶
CollectionId |
[required] The ID of an existing collection from which the UserID needs to be deleted. |
UserId |
[required] ID for the UserID to be deleted. |
ClientRequestToken |
Idempotent token used to identify the request to
|
Value¶
An empty list.
Request syntax¶
svc$delete_user(
CollectionId = "string",
UserId = "string",
ClientRequestToken = "string"
)