AmazonRekognitionClient.CreateUser Method (CreateUserRequest)

Creates a new User within a collection specified by CollectionId. Takes UserId as a parameter, which is a user provided ID which should be unique within the collection. The provided UserId will alias the system generated UUID to make the UserId more user friendly.

Uses a ClientToken, an idempotency token that ensures a call to CreateUser completes only once. If the value is not supplied, the AWS SDK generates an idempotency token for the requests. This prevents retries after a network error results from making multiple CreateUser calls.

Note:

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

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

Syntax

public virtual CreateUserResponse CreateUser(
         CreateUserRequest request
)

Parameters

request: Type: Amazon.Rekognition.Model.CreateUserRequest

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

Return Value

Type: CreateUserResponse

The response from the CreateUser 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.
ServiceQuotaExceededException	The size of the collection exceeds the allowed limit. For more information, see Guidelines and quotas in Amazon Rekognition in the Amazon Rekognition Developer Guide.
ThrottlingException	Amazon Rekognition is temporarily unable to process the request. Try your call again.

Examples

Creates a new User within a collection specified by CollectionId.

CreateUser


var client = new AmazonRekognitionClient();
var response = client.CreateUser(new CreateUserRequest 
{
    CollectionId = "MyCollection",
    UserId = "DemoUser"
});

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonRekognitionClient.CreateUser (CreateUserRequest)

Method