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

Class: Aws::MTurk::Types::HIT

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

Overview

The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_duration_in_secondsInteger

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

Returns:

  • (Integer)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#auto_approval_delay_in_secondsInteger

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

Returns:

  • (Integer)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#creation_timeTime

The date and time the HIT was created.

Returns:

  • (Time)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#descriptionString

A general description of the HIT.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#expirationTime

The date and time the HIT expires.

Returns:

  • (Time)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#hit_group_idString

The ID of the HIT Group of this HIT.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#hit_idString

A unique identifier for the HIT.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#hit_layout_idString

The ID of the HIT Layout of this HIT.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#hit_review_statusString

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#hit_statusString

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#hit_type_idString

The ID of the HIT type of this HIT

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#keywordsString

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#max_assignmentsInteger

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Returns:

  • (Integer)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#number_of_assignments_availableInteger

The number of assignments for this HIT that are available for Workers to accept.

Returns:

  • (Integer)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#number_of_assignments_completedInteger

The number of assignments for this HIT that have been approved or rejected.

Returns:

  • (Integer)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#number_of_assignments_pendingInteger

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

Returns:

  • (Integer)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#qualification_requirementsArray<Types::QualificationRequirement>

A condition that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met by a Worker's Qualifications for the Worker to accept the HIT.



1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#questionString

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#requester_annotationString

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#rewardString

A string representing a numeric value.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end

#titleString

The title of the HIT.

Returns:

  • (String)


1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1337

class HIT < Struct.new(
  :hit_id,
  :hit_type_id,
  :hit_group_id,
  :hit_layout_id,
  :creation_time,
  :title,
  :description,
  :question,
  :keywords,
  :hit_status,
  :max_assignments,
  :reward,
  :auto_approval_delay_in_seconds,
  :expiration,
  :assignment_duration_in_seconds,
  :requester_annotation,
  :qualification_requirements,
  :hit_review_status,
  :number_of_assignments_pending,
  :number_of_assignments_available,
  :number_of_assignments_completed)
  include Aws::Structure
end