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 delete_user. If you use the same token with multiple delete_userrequests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

Value¶

An empty list.

Request syntax¶

svc$delete_user(
  CollectionId = "string",
  UserId = "string",
  ClientRequestToken = "string"
)

Examples¶

## Not run: 
# Deletes the specified UserID within the collection.
svc$delete_user(
  ClientRequestToken = "550e8400-e29b-41d4-a716-446655440001",
  CollectionId = "MyCollection",
  UserId = "DemoUser"
)

## End(Not run)