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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::ListFacesRequest

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #collection_id ⇒ String

  ID of the collection from which to list the faces.

• #face_ids ⇒ Array<String>

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

• #max_results ⇒ Integer

  Maximum number of faces to return.

• #next_token ⇒ String

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

• #user_id ⇒ String

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

Instance Attribute Details

#collection_id ⇒ String

ID of the collection from which to list the faces.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5031

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results,
  :user_id,
  :face_ids)
  SENSITIVE = []
  include Aws::Structure
end

#face_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5031

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results,
  :user_id,
  :face_ids)
  SENSITIVE = []
  include Aws::Structure
end

#max_results ⇒ Integer

Maximum number of faces to return.

Returns:

• (Integer)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5031

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results,
  :user_id,
  :face_ids)
  SENSITIVE = []
  include Aws::Structure
end

#next_token ⇒ 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.

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5031

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results,
  :user_id,
  :face_ids)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 5031

class ListFacesRequest < Struct.new(
  :collection_id,
  :next_token,
  :max_results,
  :user_id,
  :face_ids)
  SENSITIVE = []
  include Aws::Structure
end