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

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

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 GetFaceSearchRequest data as a hash:

{
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
  sort_by: "INDEX", # accepts INDEX, TIMESTAMP
}

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)


1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1479

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  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)


1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1479

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  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)


1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1479

class GetFaceSearchRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by)
  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)


1479
1480
1481
1482
1483
1484
1485
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1479

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