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

Class: Aws::MTurk::Types::ListReviewPolicyResultsForHITRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb

Overview

Note:

When making an API call, you may pass ListReviewPolicyResultsForHITRequest data as a hash:

{
  hit_id: "EntityId", # required
  policy_levels: ["Assignment"], # accepts Assignment, HIT
  retrieve_actions: false,
  retrieve_results: false,
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#hit_idString

The unique identifier of the HIT to retrieve review results for.

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1807

class ListReviewPolicyResultsForHITRequest < Struct.new(
  :hit_id,
  :policy_levels,
  :retrieve_actions,
  :retrieve_results,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

Limit the number of results returned.

Returns:

  • (Integer)


1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1807

class ListReviewPolicyResultsForHITRequest < Struct.new(
  :hit_id,
  :policy_levels,
  :retrieve_actions,
  :retrieve_results,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

Pagination token

Returns:

  • (String)


1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1807

class ListReviewPolicyResultsForHITRequest < Struct.new(
  :hit_id,
  :policy_levels,
  :retrieve_actions,
  :retrieve_results,
  :next_token,
  :max_results)
  include Aws::Structure
end

#policy_levelsArray<String>

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

Returns:

  • (Array<String>)


1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1807

class ListReviewPolicyResultsForHITRequest < Struct.new(
  :hit_id,
  :policy_levels,
  :retrieve_actions,
  :retrieve_results,
  :next_token,
  :max_results)
  include Aws::Structure
end

#retrieve_actionsBoolean

Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

Returns:

  • (Boolean)


1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1807

class ListReviewPolicyResultsForHITRequest < Struct.new(
  :hit_id,
  :policy_levels,
  :retrieve_actions,
  :retrieve_results,
  :next_token,
  :max_results)
  include Aws::Structure
end

#retrieve_resultsBoolean

Specify if the operation should retrieve a list of the results computed by the Review Policies.

Returns:

  • (Boolean)


1807
1808
1809
1810
1811
1812
1813
1814
1815
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1807

class ListReviewPolicyResultsForHITRequest < Struct.new(
  :hit_id,
  :policy_levels,
  :retrieve_actions,
  :retrieve_results,
  :next_token,
  :max_results)
  include Aws::Structure
end