List Users

rekognition_list_users

R Documentation

Returns metadata of the User such as UserID in the specified collection¶

Description¶

Returns metadata of the User such as UserID in the specified collection. Anonymous User (to reserve faces without any identity) is not returned as part of this request. The results are sorted by system generated primary key ID. If the response is truncated, NextToken is returned in the response that can be used in the subsequent request to retrieve the next set of identities.

Usage¶

rekognition_list_users(CollectionId, MaxResults, NextToken)

Arguments¶

CollectionId: [required] The ID of an existing collection.
MaxResults: Maximum number of UsersID to return.
NextToken: Pagingation token to receive the next set of UsersID.

Value¶

A list with the following syntax:

list(
  Users = list(
    list(
      UserId = "string",
      UserStatus = "ACTIVE"|"UPDATING"|"CREATING"|"CREATED"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_users(
  CollectionId = "string",
  MaxResults = 123,
  NextToken = "string"
)

Examples¶

## Not run: 
# Returns metadata of the User such as UserID in the specified collection.
svc$list_users(
  CollectionId = "MyCollection"
)

## End(Not run)