Interface ListFacesRequest

interface ListFacesRequest {
    CollectionId: undefined | string;
    FaceIds?: string[];
    MaxResults?: number;
    NextToken?: string;
    UserId?: string;
}

Hierarchy (view full)

Properties

CollectionId FaceIds? MaxResults? NextToken? UserId?

Properties

CollectionId

CollectionId: undefined | string

ID of the collection from which to list the faces.

Optional FaceIds

FaceIds?: string[]

An array of face IDs to filter results with when listing faces in a collection.

Optional MaxResults

MaxResults?: number

Maximum number of faces to return.

Optional NextToken

NextToken?: string

If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.

Optional UserId

UserId?: string

An array of user IDs to filter results with when listing faces in a collection.

Settings

Member Visibility

Theme

On This Page