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.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Rekognition::Types::ListFacesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ListFacesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  collection_id: "CollectionId", # required
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#collection_idString

ID of the collection from which to list the faces.

Returns:

  • (String)

    ID of the collection from which to list the faces.

#max_resultsInteger

Maximum number of faces to return.

Returns:

  • (Integer)

    Maximum number of faces to return.

#next_tokenString

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.

Returns:

  • (String)

    If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response.