Skip to content

Creates a new User within a collection specified by CollectionId

Description

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 create_user 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 create_user calls.

Usage

rekognition_create_user(CollectionId, UserId, ClientRequestToken)

Arguments

  • CollectionId

    [required] The ID of an existing collection to which the new UserID needs to be created.

  • UserId

    [required] ID for the UserID to be created. This ID needs to be unique within the collection.

  • ClientRequestToken

    Idempotent token used to identify the request to create_user. If you use the same token with multiple create_user requests, 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$create_user(
  CollectionId = "string",
  UserId = "string",
  ClientRequestToken = "string"
)