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

Class: Aws::Rekognition::Types::GetFaceDetectionRequest

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

{
  job_id: "JobId", # required
  max_results: 1,
  next_token: "PaginationToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

Unique identifier for the face detection job. The JobId is returned from StartFaceDetection.

Returns:

  • (String)


1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1371

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

#max_resultsInteger

Maximum number of detected faces to return. The default is 1000.

Returns:

  • (Integer)


1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1371

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

#next_tokenString

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

Returns:

  • (String)


1371
1372
1373
1374
1375
1376
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1371

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