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

Class: Aws::MTurk::Types::CreateHITRequest

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

{
  max_assignments: 1,
  auto_approval_delay_in_seconds: 1,
  lifetime_in_seconds: 1, # required
  assignment_duration_in_seconds: 1, # required
  reward: "CurrencyAmount", # required
  title: "String", # required
  keywords: "String",
  description: "String", # required
  question: "String",
  requester_annotation: "String",
  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,
    },
  ],
  unique_request_token: "IdempotencyToken",
  assignment_review_policy: {
    policy_name: "String", # required
    parameters: [
      {
        key: "String",
        values: ["String"],
        map_entries: [
          {
            key: "String",
            values: ["String"],
          },
        ],
      },
    ],
  },
  hit_review_policy: {
    policy_name: "String", # required
    parameters: [
      {
        key: "String",
        values: ["String"],
        map_entries: [
          {
            key: "String",
            values: ["String"],
          },
        ],
      },
    ],
  },
  hit_layout_id: "EntityId",
  hit_layout_parameters: [
    {
      name: "String", # required
      value: "String", # required
    },
  ],
}

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)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#assignment_review_policyTypes::ReviewPolicy

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Returns:



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  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)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  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)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#hit_layout_idString

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#hit_layout_parametersArray<Types::HITLayoutParameter>

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Returns:



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#hit_review_policyTypes::ReviewPolicy

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Returns:



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  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)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#lifetime_in_secondsInteger

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

Returns:

  • (Integer)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#max_assignmentsInteger

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

Returns:

  • (Integer)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  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.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#questionString

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#requester_annotationString

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#rewardString

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

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  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)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#unique_request_tokenString

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Returns:

  • (String)


484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 484

class CreateHITRequest < Struct.new(
  :max_assignments,
  :auto_approval_delay_in_seconds,
  :lifetime_in_seconds,
  :assignment_duration_in_seconds,
  :reward,
  :title,
  :keywords,
  :description,
  :question,
  :requester_annotation,
  :qualification_requirements,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end