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

Class: Aws::Rekognition::Types::GetCelebrityRecognitionRequest

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to StartCelebrityRecognition.

Returns:

  • (String)


1227
1228
1229
1230
1231
1232
1233
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1227

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

#max_resultsInteger

Maximum number of celebrities you want Rekognition Video to return in the response. The default is 1000.

Returns:

  • (Integer)


1227
1228
1229
1230
1231
1232
1233
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1227

class GetCelebrityRecognitionRequest < 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 recognized celebrities to retrieve), Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities.

Returns:

  • (String)


1227
1228
1229
1230
1231
1232
1233
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1227

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

#sort_byString

Sort to use for celebrities returned in Celebrities field. Specify ID to sort by the celebrity identifier, specify TIMESTAMP to sort by the time the celebrity was recognized.

Returns:

  • (String)


1227
1228
1229
1230
1231
1232
1233
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1227

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