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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Overview

Note:

When making an API call, you may pass ListFacesRequest data as a 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)


1984
1985
1986
1987
1988
1989
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1984

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

Maximum number of faces to return.

Returns:

  • (Integer)


1984
1985
1986
1987
1988
1989
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1984

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#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)


1984
1985
1986
1987
1988
1989
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1984

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results)
  include Aws::Structure
end