Class: Aws::Rekognition::Types::GetContentModerationRequest

Inherits:

Struct

• Object
• Struct
• Aws::Rekognition::Types::GetContentModerationRequest

Defined in:

gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #aggregate_by ⇒ String

  Defines how to aggregate results of the StartContentModeration request.

• #job_id ⇒ String

  The identifier for the inappropriate, unwanted, or offensive content moderation job.

• #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 data to retrieve), Amazon Rekognition returns a pagination token in the response.

• #sort_by ⇒ String

  Sort to use for elements in the ModerationLabelDetections array.

Instance Attribute Details

#aggregate_by ⇒ String

Defines how to aggregate results of the StartContentModeration request. Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation labels over time.

Returns:

• (String)

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

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

#job_id ⇒ String

The identifier for the inappropriate, unwanted, or offensive content moderation job. Use JobId to identify the job in a subsequent call to GetContentModeration.

Returns:

• (String)

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

class GetContentModerationRequest < 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 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3469

class GetContentModerationRequest < 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 is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of content moderation labels.

Returns:

• (String)

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

class GetContentModerationRequest < 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 ModerationLabelDetections 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 'gems/aws-sdk-rekognition/lib/aws-sdk-rekognition/types.rb', line 3469

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