AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ListUsers operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Rekognition.AmazonRekognitionRequest
      Amazon.Rekognition.Model.ListUsersRequest

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

Syntax

C#
public class ListUsersRequest : AmazonRekognitionRequest
         IAmazonWebServiceRequest

The ListUsersRequest type exposes the following members

Constructors

NameDescription
Public Method ListUsersRequest()

Properties

NameTypeDescription
Public Property CollectionId System.String

Gets and sets the property CollectionId.

The ID of an existing collection.

Public Property MaxResults System.Int32

Gets and sets the property MaxResults.

Maximum number of UsersID to return.

Public Property NextToken System.String

Gets and sets the property NextToken.

Pagingation token to receive the next set of UsersID.

Examples

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

ListUsers


var client = new AmazonRekognitionClient();
var response = client.ListUsers(new ListUsersRequest 
{
    CollectionId = "MyCollection"
});

string nextToken = response.NextToken;
List<User> users = response.Users;

            

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

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