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

Class: Aws::Rekognition::Types::GetLabelDetectionRequest

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#job_idString

Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to StartlabelDetection.

Returns:

  • (String)


1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1531

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

#max_resultsInteger

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

Returns:

  • (Integer)


1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1531

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

#next_tokenString

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

Returns:

  • (String)


1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1531

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

#sort_byString

Sort to use for elements in the Labels array. Use TIMESTAMP to sort array elements by the time labels are detected. Use NAME to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by TIMESTAMP.

Returns:

  • (String)


1531
1532
1533
1534
1535
1536
1537
# File 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 1531

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