Class: Aws::Rekognition::Types::GetFaceSearchRequest

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

The job identifer for the search request. You get the job identifier from an initial call to ‘StartFaceSearch`.

Returns:

  • (String)


3642
3643
3644
3645
3646
3647
3648
3649
# File 'lib/aws-sdk-rekognition/types.rb', line 3642

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.

Returns:

  • (Integer)


3642
3643
3644
3645
3646
3647
3648
3649
# File 'lib/aws-sdk-rekognition/types.rb', line 3642

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


3642
3643
3644
3645
3646
3647
3648
3649
# File 'lib/aws-sdk-rekognition/types.rb', line 3642

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end

#sort_byString

Sort to use for grouping faces in the response. Use ‘TIMESTAMP` to group faces by the time that they are recognized. Use `INDEX` to sort by recognized faces.

Returns:

  • (String)


3642
3643
3644
3645
3646
3647
3648
3649
# File 'lib/aws-sdk-rekognition/types.rb', line 3642

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  SENSITIVE = []
  include Aws::Structure
end