AmazonRekognitionClient.DeleteUser Method (DeleteUserRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to DeleteUserAsync.

Namespace: Amazon.Rekognition
Assembly: AWSSDK.Rekognition.dll
Version: 3.x.y.z

Syntax

public virtual DeleteUserResponse DeleteUser(
         DeleteUserRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.DeleteUserRequest

Container for the necessary parameters to execute the DeleteUser service method.

Return Value

Type: DeleteUserResponse

The response from the DeleteUser service method, as returned by Rekognition.

Exceptions

Exception	Condition
AccessDeniedException	You are not authorized to perform the action.
ConflictException	A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
IdempotentParameterMismatchException	A ClientRequestToken input parameter was reused with an operation, but at least one of the other input parameters is different from the previous call to the operation.
InternalServerErrorException	Amazon Rekognition experienced a service issue. Try your call again.
InvalidParameterException	Input parameter violated a constraint. Validate your parameter before calling the API operation again.
ProvisionedThroughputExceededException	The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
ResourceNotFoundException	The resource specified in the request cannot be found.
ThrottlingException	Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Deletes the specified UserID within the collection.

DeleteUser


var client = new AmazonRekognitionClient();
var response = client.DeleteUser(new DeleteUserRequest 
{
    ClientRequestToken = "550e8400-e29b-41d4-a716-446655440001",
    CollectionId = "MyCollection",
    UserId = "DemoUser"
});

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

AmazonRekognitionClient.DeleteUser (DeleteUserRequest)

Method