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

Class: Aws::MTurk::Types::CreateHITWithHITTypeRequest

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

{
  hit_type_id: "EntityId", # required
  max_assignments: 1,
  lifetime_in_seconds: 1, # required
  question: "String",
  requester_annotation: "String",
  unique_request_token: "IdempotencyToken",
  assignment_review_policy: {
    policy_name: "String",
    parameters: [
      {
        key: "String",
        values: ["String"],
        map_entries: [
          {
            key: "String",
            values: ["String"],
          },
        ],
      },
    ],
  },
  hit_review_policy: {
    policy_name: "String",
    parameters: [
      {
        key: "String",
        values: ["String"],
        map_entries: [
          {
            key: "String",
            values: ["String"],
          },
        ],
      },
    ],
  },
  hit_layout_id: "EntityId",
  hit_layout_parameters: [
    {
      name: "String",
      value: "String",
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#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:



749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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:



749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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:



749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end

#hit_type_idString

The HIT type ID you want to create this HIT with.

Returns:

  • (String)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :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)


749
750
751
752
753
754
755
756
757
758
759
760
761
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 749

class CreateHITWithHITTypeRequest < Struct.new(
  :hit_type_id,
  :max_assignments,
  :lifetime_in_seconds,
  :question,
  :requester_annotation,
  :unique_request_token,
  :assignment_review_policy,
  :hit_review_policy,
  :hit_layout_id,
  :hit_layout_parameters)
  include Aws::Structure
end