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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetFaceSearchRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #job_id ⇒ String

  The job identifer for the search request.

• #max_results ⇒ Integer

  Maximum number of results to return per paginated call.

• #next_token ⇒ String

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

• #sort_by ⇒ String

  Sort to use for grouping faces in the response.

Instance Attribute Details

#job_id ⇒ String

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

Returns:

• (String)

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

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

#max_results ⇒ Integer

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)

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

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

#next_token ⇒ String

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)

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

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

#sort_by ⇒ String

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)

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

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