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

Class: Aws::MTurk::Types::CreateHITTypeRequest

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

{
  auto_approval_delay_in_seconds: 1,
  assignment_duration_in_seconds: 1, # required
  reward: "NumericValue", # required
  title: "String", # required
  keywords: "String",
  description: "String", # required
  qualification_requirements: [
    {
      qualification_type_id: "String", # required
      comparator: "LessThan", # required, accepts LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, NotEqualTo, Exists, DoesNotExist, In, NotIn
      integer_values: [1],
      locale_values: [
        {
          country: "CountryParameters", # required
          subdivision: "CountryParameters",
        },
      ],
      required_to_preview: false,
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_duration_in_secondsInteger

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

Returns:

  • (Integer)


591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end

#auto_approval_delay_in_secondsInteger

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

Returns:

  • (Integer)


591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end

#descriptionString

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

Returns:

  • (String)


591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end

#keywordsString

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

Returns:

  • (String)


591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end

#qualification_requirementsArray<Types::QualificationRequirement>

A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT.



591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end

#rewardString

The amount of money the Requester will pay a Worker for successfully completing the HIT.

Returns:

  • (String)


591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end

#titleString

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

Returns:

  • (String)


591
592
593
594
595
596
597
598
599
600
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 591

class CreateHITTypeRequest < Struct.new(
  :auto_approval_delay_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :qualification_requirements)
  include Aws::Structure
end