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

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetLabelDetectionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregate_by ⇒ String

  Defines how to aggregate the returned results.

• #job_id ⇒ String

  Job identifier for the label detection operation for which you want results returned.

• #max_results ⇒ Integer

  Maximum number of results to return per paginated call.

• #next_token ⇒ String

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

• #sort_by ⇒ String

  Sort to use for elements in the ‘Labels` array.

Instance Attribute Details

#aggregate_by ⇒ String

Defines how to aggregate the returned results. Results can be aggregated by timestamps or segments.

Returns:

• (String)

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

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

#job_id ⇒ String

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)

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

class GetLabelDetectionRequest < Struct.new(
  :job_id,
  :max_results,
  :next_token,
  :sort_by,
  :aggregate_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 3760

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

#next_token ⇒ String

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

Returns:

• (String)

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

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

#sort_by ⇒ String

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)

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

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