DeleteUser
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.
Request Syntax
{
"ClientRequestToken": "string
",
"CollectionId": "string
",
"UserId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
Idempotent token used to identify the request to
DeleteUser
. If you use the same token with multipleDeleteUser
requests, the same response is returned. Use ClientRequestToken to prevent the same request from being processed more than once.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$
Required: No
- CollectionId
-
The ID of an existing collection from which the UserID needs to be deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[a-zA-Z0-9_.\-]+
Required: Yes
- UserId
-
ID for the UserID to be deleted.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9_.\-:]+
Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You are not authorized to perform the action.
HTTP Status Code: 400
- ConflictException
-
A User with the same Id already exists within the collection, or the update or deletion of the User caused an inconsistent state. **
HTTP Status Code: 400
- 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.HTTP Status Code: 400
- InternalServerError
-
Amazon Rekognition experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidParameterException
-
Input parameter violated a constraint. Validate your parameter before calling the API operation again.
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Rekognition.
HTTP Status Code: 400
- ResourceNotFoundException
-
The resource specified in the request cannot be found.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Rekognition is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: