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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateHITTypeRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  auto_approval_delay_in_seconds: 1,
  assignment_duration_in_seconds: 1, # required
  reward: "CurrencyAmount", # 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,
      actions_guarded: "Accept", # accepts Accept, PreviewAndAccept, DiscoverPreviewAndAccept
    },
  ],
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_duration_in_seconds ⇒ Integer

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) —

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

#auto_approval_delay_in_seconds ⇒ Integer

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) —

    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.

#description ⇒ String

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) —

    A general description of the HIT.

#keywords ⇒ String

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

Returns:

  • (String) —

    One or more words or phrases that describe the HIT, separated by commas.

#qualification_requirements ⇒ Array<Types::QualificationRequirement>

Conditions 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 in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Returns:

#reward ⇒ String

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

Returns:

  • (String) —

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

#title ⇒ String

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) —

    The title of the HIT.