Skip to content

List Faces

rekognition_list_faces R Documentation

Returns metadata for faces in the specified collection

Description

Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:ListFaces action.

Usage

rekognition_list_faces(CollectionId, NextToken, MaxResults, UserId,
  FaceIds)

Arguments

CollectionId

[required] ID of the collection from which to list the faces.

NextToken

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.

MaxResults

Maximum number of faces to return.

UserId

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

FaceIds

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

Value

A list with the following syntax: 

list(
  Faces = list(
    list(
      FaceId = "string",
      BoundingBox = list(
        Width = 123.0,
        Height = 123.0,
        Left = 123.0,
        Top = 123.0
      ),
      ImageId = "string",
      ExternalImageId = "string",
      Confidence = 123.0,
      IndexFacesModelVersion = "string",
      UserId = "string"
    )
  ),
  NextToken = "string",
  FaceModelVersion = "string"
)

Request syntax

svc$list_faces(
  CollectionId = "string",
  NextToken = "string",
  MaxResults = 123,
  UserId = "string",
  FaceIds = list(
    "string"
  )
)

Examples

## Not run: 
# This operation lists the faces in a Rekognition collection.
svc$list_faces(
  CollectionId = "myphotos",
  MaxResults = 20L
)

## End(Not run)