You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::MTurk::Types::CreateHITWithHITTypeRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MTurk::Types::CreateHITWithHITTypeRequest
- Defined in:
- (unknown)
Overview
When passing CreateHITWithHITTypeRequest as input to an Aws::Client method, you can use a vanilla 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", # 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
-
#assignment_review_policy ⇒ Types::ReviewPolicy
The Assignment-level Review Policy applies to the assignments under the HIT.
-
#hit_layout_id ⇒ String
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.
-
#hit_layout_parameters ⇒ Array<Types::HITLayoutParameter>
If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure.
-
#hit_review_policy ⇒ Types::ReviewPolicy
The HIT-level Review Policy applies to the HIT.
-
#hit_type_id ⇒ String
The HIT type ID you want to create this HIT with.
-
#lifetime_in_seconds ⇒ Integer
An amount of time, in seconds, after which the HIT is no longer available for users to accept.
-
#max_assignments ⇒ Integer
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
-
#question ⇒ String
The data the person completing the HIT uses to produce the results.
-
#requester_annotation ⇒ String
An arbitrary data field.
-
#unique_request_token ⇒ String
A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs.
Instance Attribute Details
#assignment_review_policy ⇒ Types::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.
#hit_layout_id ⇒ String
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.
#hit_layout_parameters ⇒ Array<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.
#hit_review_policy ⇒ Types::ReviewPolicy
The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.
#hit_type_id ⇒ String
The HIT type ID you want to create this HIT with.
#lifetime_in_seconds ⇒ Integer
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.
#max_assignments ⇒ Integer
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
#question ⇒ String
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.
#requester_annotation ⇒ String
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.
#unique_request_token ⇒ String
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.