Rekognition / Client / delete_user

delete_user#

Rekognition.Client.delete_user(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.delete_user(
    CollectionId='string',
    UserId='string',
    ClientRequestToken='string'
)
Parameters:

  • CollectionId (string) –

    [REQUIRED]

    The ID of an existing collection from which the UserID needs to be deleted.

  • UserId (string) –

    [REQUIRED]

    ID for the UserID to be deleted.

  • ClientRequestToken (string) –

    Idempotent token used to identify the request to DeleteUser. If you use the same token with multiple ``DeleteUser ``requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • Rekognition.Client.exceptions.InvalidParameterException

  • Rekognition.Client.exceptions.ConflictException

  • Rekognition.Client.exceptions.ResourceNotFoundException

  • Rekognition.Client.exceptions.ProvisionedThroughputExceededException

  • Rekognition.Client.exceptions.IdempotentParameterMismatchException

  • Rekognition.Client.exceptions.AccessDeniedException

  • Rekognition.Client.exceptions.InternalServerError

  • Rekognition.Client.exceptions.ThrottlingException