Smaws_Client_MTurk.Typestype nonrec worker_block = {reason : string_ option;A message explaining the reason the Worker was blocked.
*)worker_id : customer_id option;The ID of the Worker who accepted the HIT.
*)}The WorkerBlock data structure represents a Worker who has been blocked. It has two elements: the WorkerId and the Reason for the block.
type nonrec worker_block_list = worker_block listtype nonrec long = Smaws_Lib.CoreTypes.Int64.ttype nonrec qualification_type = {auto_granted_value : integer option;The Qualification integer value to use for automatically granted Qualifications, if AutoGranted is true. This is 1 by default.
*)auto_granted : boolean_ option;Specifies that requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test. Valid values are True | False.
*)is_requestable : boolean_ option;Specifies whether the Qualification type is one that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test. This value is False for Qualifications assigned automatically by the system. Valid values are True | False.
*)retry_delay_in_seconds : long option;The amount of time, in seconds, Workers must wait after taking the Qualification test before they can take it again. Workers can take a Qualification test multiple times if they were not granted the Qualification from a previous attempt, or if the test offers a gradient score and they want a better score. If not specified, retries are disabled and Workers can request a Qualification only once.
*)answer_key : string_ option;The answers to the Qualification test specified in the Test parameter.
*)test_duration_in_seconds : long option;The amount of time, in seconds, given to a Worker to complete the Qualification test, beginning from the time the Worker requests the Qualification.
*)test : string_ option;The questions for a Qualification test associated with this Qualification type that a user can take to obtain a Qualification of this type. This parameter must be specified if AnswerKey is present. A Qualification type cannot have both a specified Test parameter and an AutoGranted value of true.
*)qualification_type_status : qualification_type_status option;The status of the Qualification type. A Qualification type's status determines if users can apply to receive a Qualification of this type, and if HITs can be created with requirements based on this type. Valid values are Active | Inactive.
*)keywords : string_ option;One or more words or phrases that describe theQualification type, separated by commas. The Keywords make the type easier to find using a search.
*)description : string_ option;A long description for the Qualification type.
*)name : string_ option;The name of the Qualification type. The type name is used to identify the type, and to find the type using a Qualification type search.
*)creation_time : timestamp option;The date and time the Qualification type was created.
*)qualification_type_id : entity_id option;A unique identifier for the Qualification type. A Qualification type is given a Qualification type ID when you call the CreateQualificationType operation.
*)}The QualificationType data structure represents a Qualification type, a description of a property of a Worker that must match the requirements of a HIT for the Worker to be able to accept the HIT. The type also describes how a Worker can obtain a Qualification of that type, such as through a Qualification test.
type nonrec update_qualification_type_response = {qualification_type : qualification_type option;Contains a QualificationType data structure.
*)}type nonrec update_qualification_type_request = {auto_granted_value : integer option;The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
*)auto_granted : boolean_ option;Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.
Constraints: If the Test parameter is specified, this parameter cannot be true.
*)retry_delay_in_seconds : long option;The amount of time, in seconds, that Workers must wait after requesting a Qualification of the specified Qualification type before they can retry the Qualification request. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must dispose of the existing retry-enabled Qualification type using DisposeQualificationType and then create a new Qualification type with retries disabled using CreateQualificationType.
*)test_duration_in_seconds : long option;The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
*)answer_key : string_ option;The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
*)test : string_ option;The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.
Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.
Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.
*)qualification_type_status : qualification_type_status option;The new status of the Qualification type - Active | Inactive
*)description : string_ option;The new description of the Qualification type.
*)qualification_type_id : entity_id;The ID of the Qualification type to update.
*)}type nonrec service_fault = {turk_error_code : turk_error_code option;message : exception_message option;}Amazon Mechanical Turk is temporarily unable to process your request. Try your call again.
type nonrec request_error = {turk_error_code : turk_error_code option;message : exception_message option;}Your request is invalid.
type nonrec event_type_list = event_type listtype nonrec notification_specification = {event_types : event_type_list;The list of events that should cause notifications to be sent. Valid Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned | AssignmentSubmitted | AssignmentRejected | AssignmentApproved | HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired | Ping. The Ping event is only valid for the SendTestEventNotification operation.
*)version : string_;The version of the Notification API to use. Valid value is 2006-05-05.
*)transport : notification_transport;The method Amazon Mechanical Turk uses to send the notification. Valid Values: Email | SQS | SNS.
*)destination : string_;The target for notification messages. The Destination’s format is determined by the specified Transport:
}The NotificationSpecification data structure describes a HIT event notification for a HIT type.
type nonrec update_notification_settings_request = {active : boolean_ option;Specifies whether notifications are sent for HITs of this HIT type, according to the notification specification. You must specify either the Notification parameter or the Active parameter for the call to UpdateNotificationSettings to succeed.
*)notification : notification_specification option;The notification specification for the HIT type.
*)hit_type_id : entity_id;The ID of the HIT type whose notification specification is being updated.
*)}type nonrec update_hit_review_status_request = {revert : boolean_ option;Specifies how to update the HIT status. Default is False.
Reviewable to ReviewingReviewing to Reviewablehit_id : entity_id;The ID of the HIT to update.
*)}type nonrec string_list = string_ listtype nonrec send_test_event_notification_request = {test_event_type : event_type;The event to simulate to test the notification specification. This event is included in the test message even if the notification specification does not include the event type. The notification specification does not filter out the test event.
*)notification : notification_specification;The notification specification to test. This value is identical to the value you would provide to the UpdateNotificationSettings operation when you establish the notification specification for a HIT type.
*)}type nonrec send_bonus_request = {unique_request_token : idempotency_token option;A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
*)reason : string_;A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.
*)assignment_id : entity_id;The ID of the assignment for which this bonus is paid.
*)bonus_amount : currency_amount;The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.
*)worker_id : customer_id;The ID of the Worker being paid the bonus.
*)}type nonrec review_result_detail = {value : string_ option;The values of Key provided by the review policies you have selected.
*)key : string_ option;Key identifies the particular piece of reviewed information.
*)question_id : entity_id option;Specifies the QuestionId the result is describing. Depending on whether the TargetType is a HIT or Assignment this results could specify multiple values. If TargetType is HIT and QuestionId is absent, then the result describes results of the HIT, including the HIT agreement score. If ObjectType is Assignment and QuestionId is absent, then the result describes the Worker's performance on the HIT.
*)subject_type : string_ option;The type of the object from the SubjectId field.
*)subject_id : entity_id option;The HITID or AssignmentId about which this result was taken. Note that HIT-level Review Policies will often emit results about both the HIT itself and its Assignments, while Assignment-level review policies generally only emit results about the Assignment itself.
*)action_id : entity_id option;A unique identifier of the Review action result.
*)}This data structure is returned multiple times for each result specified in the Review Policy.
type nonrec review_result_detail_list = review_result_detail listtype nonrec review_action_detail = {error_code : string_ option;Present only when the Results have a FAILED Status.
*)result_ : string_ option;A description of the outcome of the review.
*)complete_time : timestamp option;The date when the action was completed.
*)status : review_action_status option;The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.
*)target_type : string_ option;The type of object in TargetId.
*)target_id : entity_id option;The specific HITId or AssignmentID targeted by the action.
*)action_name : string_ option;The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary.
*)action_id : entity_id option;The unique identifier for the action.
*)}Both the AssignmentReviewReport and the HITReviewReport elements contains the ReviewActionDetail data structure. This structure is returned multiple times for each action specified in the Review Policy.
type nonrec review_action_detail_list = review_action_detail listtype nonrec review_report = {review_actions : review_action_detail_list option;A list of ReviewAction objects for each action specified in the Review Policy.
*)review_results : review_result_detail_list option;A list of ReviewResults objects for each action specified in the Review Policy.
*)}Contains both ReviewResult and ReviewAction elements for a particular HIT.
type nonrec review_policy_level_list = review_policy_level listtype nonrec parameter_map_entry = {values : string_list option;The list of answers to the question specified in the MapEntry Key element. The Worker must match all values in order for the answer to be scored correctly.
*)key : string_ option;The QuestionID from the HIT that is used to identify which question requires Mechanical Turk to score as part of the ScoreMyKnownAnswers/2011-09-01 Review Policy.
*)}This data structure is the data type for the AnswerKey parameter of the ScoreMyKnownAnswers/2011-09-01 Review Policy.
type nonrec parameter_map_entry_list = parameter_map_entry listtype nonrec policy_parameter = {map_entries : parameter_map_entry_list option;List of ParameterMapEntry objects.
*)values : string_list option;The list of values of the Parameter
*)key : string_ option;Name of the parameter from the list of Review Polices.
*)}Name of the parameter from the Review policy.
type nonrec policy_parameter_list = policy_parameter listtype nonrec review_policy = {parameters : policy_parameter_list option;Name of the parameter from the Review policy.
*)policy_name : string_;Name of a Review Policy: SimplePlurality/2011-09-01 or ScoreMyKnownAnswers/2011-09-01
*)}HIT Review Policy data structures represent HIT review policies, which you specify when you create a HIT.
type nonrec reject_qualification_request_request = {reason : string_ option;A text message explaining why the request was rejected, to be shown to the Worker who made the request.
*)qualification_request_id : string_;The ID of the Qualification request, as returned by the ListQualificationRequests operation.
}type nonrec qualification_type_list = qualification_type listtype nonrec integer_list = integer listtype nonrec locale = {subdivision : country_parameters option;The state or subdivision of the locale. A valid ISO 3166-2 subdivision code. For example, the code WA refers to the state of Washington.
*)country : country_parameters;The country of the locale. Must be a valid ISO 3166 country code. For example, the code US refers to the United States of America.
*)}The Locale data structure represents a geographical region or location.
type nonrec locale_list = locale listtype nonrec qualification_requirement = {actions_guarded : hit_access_actions option;Setting this attribute prevents Workers whose Qualifications do not meet this QualificationRequirement from taking the specified action. Valid arguments include "Accept" (Worker cannot accept the HIT, but can preview the HIT and see it in their search results), "PreviewAndAccept" (Worker cannot accept or preview the HIT, but can see the HIT in their search results), and "DiscoverPreviewAndAccept" (Worker cannot accept, preview, or see the HIT in their search results). It's possible for you to create a HIT with multiple QualificationRequirements (which can have different values for the ActionGuarded attribute). In this case, the Worker is only permitted to perform an action when they have met all QualificationRequirements guarding the action. The actions in the order of least restrictive to most restrictive are Discover, Preview and Accept. For example, if a Worker meets all QualificationRequirements that are set to DiscoverPreviewAndAccept, but do not meet all requirements that are set with PreviewAndAccept, then the Worker will be able to Discover, i.e. see the HIT in their search result, but will not be able to Preview or Accept the HIT. ActionsGuarded should not be used in combination with the RequiredToPreview field.
required_to_preview : boolean_ option;DEPRECATED: Use the ActionsGuarded field instead. If RequiredToPreview is true, the question data for the HIT will not be shown when a Worker whose Qualifications do not meet this requirement tries to preview the HIT. That is, a Worker's Qualifications must meet all of the requirements for which RequiredToPreview is true in order to preview the HIT. If a Worker meets all of the requirements where RequiredToPreview is true (or if there are no such requirements), but does not meet all of the requirements for the HIT, the Worker will be allowed to preview the HIT's question data, but will not be allowed to accept and complete the HIT. The default is false. This should not be used in combination with the ActionsGuarded field.
locale_values : locale_list option;The locale value to compare against the Qualification's value. The local value must be a valid ISO 3166 country code or supports ISO 3166-2 subdivisions. LocaleValue can only be used with a Worker_Locale QualificationType ID. LocaleValue can only be used with the EqualTo, NotEqualTo, In, and NotIn comparators. You must only use a single LocaleValue element when using the EqualTo or NotEqualTo comparators. When performing a set comparison by using the In or the NotIn comparator, you can use up to 30 LocaleValue elements in a QualificationRequirement data structure.
*)integer_values : integer_list option;The integer value to compare against the Qualification's value. IntegerValue must not be present if Comparator is Exists or DoesNotExist. IntegerValue can only be used if the Qualification type has an integer value; it cannot be used with the Worker_Locale QualificationType ID. When performing a set comparison by using the In or the NotIn comparator, you can use up to 15 IntegerValue elements in a QualificationRequirement data structure.
*)comparator : comparator;The kind of comparison to make against a Qualification's value. You can compare a Qualification's value to an IntegerValue to see if it is LessThan, LessThanOrEqualTo, GreaterThan, GreaterThanOrEqualTo, EqualTo, or NotEqualTo the IntegerValue. You can compare it to a LocaleValue to see if it is EqualTo, or NotEqualTo the LocaleValue. You can check to see if the value is In or NotIn a set of IntegerValue or LocaleValue values. Lastly, a Qualification requirement can also test if a Qualification Exists or DoesNotExist in the user's profile, regardless of its value.
*)qualification_type_id : string_;The ID of the Qualification type for the requirement.
*)}The QualificationRequirement data structure describes a Qualification that a Worker must have before the Worker is allowed to accept a HIT. A requirement may optionally state that a Worker must have the Qualification in order to preview the HIT, or see the HIT in search results.
type nonrec qualification_requirement_list = qualification_requirement listtype nonrec qualification_request = {submit_time : timestamp option;The date and time the Qualification request had a status of Submitted. This is either the time the Worker submitted answers for a Qualification test, or the time the Worker requested the Qualification if the Qualification type does not have a test.
*)answer : string_ option;The Worker's answers for the Qualification type's test contained in a QuestionFormAnswers document, if the type has a test and the Worker has submitted answers. If the Worker does not provide any answers, Answer may be empty.
*)test : string_ option;The contents of the Qualification test that was presented to the Worker, if the type has a test and the Worker has submitted answers. This value is identical to the QuestionForm associated with the Qualification type at the time the Worker requests the Qualification.
*)worker_id : customer_id option;The ID of the Worker requesting the Qualification.
*)qualification_type_id : entity_id option;The ID of the Qualification type the Worker is requesting, as returned by the CreateQualificationType operation.
*)qualification_request_id : string_ option;The ID of the Qualification request, a unique identifier generated when the request was submitted.
*)}The QualificationRequest data structure represents a request a Worker has made for a Qualification.
type nonrec qualification_request_list = qualification_request listtype nonrec qualification = {status : qualification_status option;The status of the Qualification. Valid values are Granted | Revoked.
*)locale_value : locale option;integer_value : integer option;The value (score) of the Qualification, if the Qualification has an integer value.
*)grant_time : timestamp option;The date and time the Qualification was granted to the Worker. If the Worker's Qualification was revoked, and then re-granted based on a new Qualification request, GrantTime is the date and time of the last call to the AcceptQualificationRequest operation.
*)worker_id : customer_id option;The ID of the Worker who possesses the Qualification.
*)qualification_type_id : entity_id option;The ID of the Qualification type for the Qualification.
*)}The Qualification data structure represents a Qualification assigned to a user, including the Qualification type and the value (score).
type nonrec qualification_list = qualification listtype nonrec notify_workers_failure_status = {worker_id : customer_id option;The ID of the Worker.
*)notify_workers_failure_message : string_ option;A message detailing the reason the Worker could not be notified.
*)notify_workers_failure_code : notify_workers_failure_code option;Encoded value for the failure type.
*)}When MTurk encounters an issue with notifying the Workers you specified, it returns back this object with failure details.
type nonrec notify_workers_failure_status_list =
notify_workers_failure_status listtype nonrec notify_workers_response = {notify_workers_failure_statuses : notify_workers_failure_status_list option;When MTurk sends notifications to the list of Workers, it returns back any failures it encounters in this list of NotifyWorkersFailureStatus objects.
*)}type nonrec customer_id_list = customer_id listtype nonrec notify_workers_request = {worker_ids : customer_id_list;A list of Worker IDs you wish to notify. You can notify upto 100 Workers at a time.
*)message_text : string_;The text of the email message to send. Can include up to 4,096 characters
*)subject : string_;The subject line of the email message to send. Can include up to 200 characters.
*)}type nonrec list_workers_with_qualification_type_response = {qualifications : qualification_list option;The list of Qualification elements returned by this call.
*)num_results : integer option;The number of Qualifications on this page in the filtered results list, equivalent to the number of Qualifications being returned by this call.
*)next_token : pagination_token option;}type nonrec list_workers_with_qualification_type_request = {max_results : result_size option;Limit the number of results returned.
*)next_token : pagination_token option;Pagination Token
*)status : qualification_status option;The status of the Qualifications to return. Can be Granted | Revoked.
qualification_type_id : entity_id;The ID of the Qualification type of the Qualifications to return.
*)}type nonrec list_worker_blocks_response = {worker_blocks : worker_block_list option;The list of WorkerBlocks, containing the collection of Worker IDs and reasons for blocking.
*)num_results : integer option;The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.
*)next_token : pagination_token option;}type nonrec list_worker_blocks_request = {max_results : result_size option;next_token : pagination_token option;Pagination token
*)}type nonrec list_review_policy_results_for_hit_response = {next_token : pagination_token option;hit_review_report : review_report option;Contains both ReviewResult and ReviewAction elements for a particular HIT.
*)assignment_review_report : review_report option;Contains both ReviewResult and ReviewAction elements for an Assignment.
*)hit_review_policy : review_policy option;The name of the HIT-level Review Policy. This contains only the PolicyName element.
*)assignment_review_policy : review_policy option;The name of the Assignment-level Review Policy. This contains only the PolicyName element.
*)hit_id : entity_id option;The HITId of the HIT for which results have been returned.
*)}type nonrec list_review_policy_results_for_hit_request = {max_results : result_size option;Limit the number of results returned.
*)next_token : pagination_token option;Pagination token
*)retrieve_results : boolean_ option;Specify if the operation should retrieve a list of the results computed by the Review Policies.
*)retrieve_actions : boolean_ option;Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.
*)policy_levels : review_policy_level_list option;The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.
*)hit_id : entity_id;The unique identifier of the HIT to retrieve review results for.
*)}type nonrec hi_t = {number_of_assignments_completed : integer option;The number of assignments for this HIT that have been approved or rejected.
*)number_of_assignments_available : integer option;The number of assignments for this HIT that are available for Workers to accept.
*)number_of_assignments_pending : integer option;The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.
*)hit_review_status : hit_review_status option;Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
*)qualification_requirements : qualification_requirement_list option;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.
requester_annotation : string_ option;An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.
*)assignment_duration_in_seconds : long option;The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
*)expiration : timestamp option;The date and time the HIT expires.
*)auto_approval_delay_in_seconds : long option;The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.
*)reward : currency_amount option;max_assignments : integer option;The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
*)hit_status : hit_status option;The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
*)keywords : string_ option;One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.
*)question : string_ option;The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.
*)description : string_ option;A general description of the HIT.
*)title : string_ option;The title of the HIT.
*)creation_time : timestamp option;The date and time the HIT was created.
*)hit_layout_id : entity_id option;The ID of the HIT Layout of this HIT.
*)hit_group_id : entity_id option;The ID of the HIT Group of this HIT.
*)hit_type_id : entity_id option;The ID of the HIT type of this HIT
*)hit_id : entity_id option;A unique identifier for the HIT.
*)}The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
type nonrec hit_list = hi_t listtype nonrec list_reviewable_hi_ts_response = {hi_ts : hit_list option;The list of HIT elements returned by the query.
*)num_results : integer option;The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.
*)next_token : pagination_token option;}type nonrec list_reviewable_hi_ts_request = {max_results : result_size option;Limit the number of results returned.
*)next_token : pagination_token option;Pagination Token
*)status : reviewable_hit_status option;Can be either Reviewable or Reviewing. Reviewable is the default value.
hit_type_id : entity_id option;The ID of the HIT type of the HITs to consider for the query. If not specified, all HITs for the Reviewer are considered
*)}type nonrec list_qualification_types_response = {qualification_types : qualification_type_list option;The list of QualificationType elements returned by the query.
*)next_token : pagination_token option;num_results : integer option;The number of Qualification types on this page in the filtered results list, equivalent to the number of types this operation returns.
*)}type nonrec list_qualification_types_request = {max_results : result_size option;The maximum number of results to return in a single call.
*)next_token : pagination_token option;must_be_owned_by_caller : boolean_ option;Specifies that only Qualification types that the Requester created are returned. If false, the operation returns all Qualification types.
*)must_be_requestable : boolean_;Specifies that only Qualification types that a user can request through the Amazon Mechanical Turk web site, such as by taking a Qualification test, are returned as results of the search. Some Qualification types, such as those assigned automatically by the system, cannot be requested directly by users. If false, all Qualification types, including those managed by the system, are considered. Valid values are True | False.
*)query : string_ option;A text query against all of the searchable attributes of Qualification types.
*)}type nonrec list_qualification_requests_response = {qualification_requests : qualification_request_list option;The Qualification request. The response includes one QualificationRequest element for each Qualification request returned by the query.
*)next_token : pagination_token option;num_results : integer option;The number of Qualification requests on this page in the filtered results list, equivalent to the number of Qualification requests being returned by this call.
*)}type nonrec list_qualification_requests_request = {max_results : result_size option;The maximum number of results to return in a single call.
*)next_token : pagination_token option;qualification_type_id : entity_id option;The ID of the QualificationType.
*)}type nonrec list_hi_ts_for_qualification_type_response = {hi_ts : hit_list option;The list of HIT elements returned by the query.
*)num_results : integer option;The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.
*)next_token : pagination_token option;}type nonrec list_hi_ts_for_qualification_type_request = {max_results : result_size option;Limit the number of results returned.
*)next_token : pagination_token option;Pagination Token
*)qualification_type_id : entity_id;The ID of the Qualification type to use when querying HITs.
*)}type nonrec list_hi_ts_response = {hi_ts : hit_list option;The list of HIT elements returned by the query.
*)num_results : integer option;The number of HITs on this page in the filtered results list, equivalent to the number of HITs being returned by this call.
*)next_token : pagination_token option;}type nonrec list_hi_ts_request = {max_results : result_size option;next_token : pagination_token option;Pagination token
*)}type nonrec bonus_payment = {grant_time : timestamp option;The date and time of when the bonus was granted.
*)reason : string_ option;The Reason text given when the bonus was granted, if any.
*)assignment_id : entity_id option;The ID of the assignment associated with this bonus payment.
*)bonus_amount : currency_amount option;worker_id : customer_id option;The ID of the Worker to whom the bonus was paid.
*)}An object representing a Bonus payment paid to a Worker.
type nonrec bonus_payment_list = bonus_payment listtype nonrec list_bonus_payments_response = {bonus_payments : bonus_payment_list option;A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.
*)next_token : pagination_token option;num_results : integer option;The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call.
*)}type nonrec list_bonus_payments_request = {max_results : result_size option;next_token : pagination_token option;Pagination token
*)assignment_id : entity_id option;The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified
*)hit_id : entity_id option;The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified
*)}type nonrec assignment = {requester_feedback : string_ option;The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.
*)answer : string_ option;The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty.
*)deadline : timestamp option;The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT.
*)rejection_time : timestamp option;If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.
*)approval_time : timestamp option;If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results.
*)submit_time : timestamp option;If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results.
*)accept_time : timestamp option;The date and time the Worker accepted the assignment.
*)auto_approval_time : timestamp option;If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results.
*)assignment_status : assignment_status option;The status of the assignment.
*)hit_id : entity_id option;The ID of the HIT.
*)worker_id : customer_id option;The ID of the Worker who accepted the HIT.
*)assignment_id : entity_id option;A unique identifier for the assignment.
*)}The Assignment data structure represents a single assignment of a HIT to a Worker. The assignment tracks the Worker's efforts to complete the HIT, and contains the results for later retrieval.
type nonrec assignment_list = assignment listtype nonrec list_assignments_for_hit_response = {assignments : assignment_list option;The collection of Assignment data structures returned by this call.
*)num_results : integer option;The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.
*)next_token : pagination_token option;}type nonrec assignment_status_list = assignment_status listtype nonrec list_assignments_for_hit_request = {assignment_statuses : assignment_status_list option;The status of the assignments to return: Submitted | Approved | Rejected
*)max_results : result_size option;next_token : pagination_token option;Pagination token
*)hit_id : entity_id;The ID of the HIT.
*)}type nonrec get_qualification_type_response = {qualification_type : qualification_type option;The returned Qualification Type
*)}type nonrec get_qualification_type_request = {qualification_type_id : entity_id;The ID of the QualificationType.
*)}type nonrec get_qualification_score_response = {qualification : qualification option;The Qualification data structure of the Qualification assigned to a user, including the Qualification type and the value (score).
*)}type nonrec get_qualification_score_request = {worker_id : customer_id;The ID of the Worker whose Qualification is being updated.
*)qualification_type_id : entity_id;The ID of the QualificationType.
*)}type nonrec get_file_upload_url_response = {file_upload_ur_l : string_ option;A temporary URL for the file that the Worker uploaded for the answer.
*)}type nonrec get_assignment_response = {hi_t : hi_t option;The HIT associated with this assignment. The response includes one HIT element.
*)assignment : assignment option;The assignment. The response includes one Assignment element.
*)}type nonrec get_assignment_request = {assignment_id : entity_id;The ID of the Assignment to be retrieved.
*)}type nonrec get_account_balance_response = {on_hold_balance : currency_amount option;available_balance : currency_amount option;}type nonrec disassociate_qualification_from_worker_request = {reason : string_ option;A text message that explains why the Qualification was revoked. The user who had the Qualification sees this message.
*)qualification_type_id : entity_id;The ID of the Qualification type of the Qualification to be revoked.
*)worker_id : customer_id;The ID of the Worker who possesses the Qualification to be revoked.
*)}type nonrec delete_worker_block_request = {reason : string_ option;A message that explains the reason for unblocking the Worker. The Worker does not see this message.
*)worker_id : customer_id;The ID of the Worker to unblock.
*)}type nonrec delete_qualification_type_request = {qualification_type_id : entity_id;The ID of the QualificationType to dispose.
*)}type nonrec create_worker_block_request = {reason : string_;A message explaining the reason for blocking the Worker. This parameter enables you to keep track of your Workers. The Worker does not see this message.
*)worker_id : customer_id;The ID of the Worker to block.
*)}type nonrec create_qualification_type_response = {qualification_type : qualification_type option;The created Qualification type, returned as a QualificationType data structure.
*)}type nonrec create_qualification_type_request = {auto_granted_value : integer option;The Qualification value to use for automatically granted Qualifications. This parameter is used only if the AutoGranted parameter is true.
*)auto_granted : boolean_ option;Specifies whether requests for the Qualification type are granted immediately, without prompting the Worker with a Qualification test.
Constraints: If the Test parameter is specified, this parameter cannot be true.
*)test_duration_in_seconds : long option;The number of seconds the Worker has to complete the Qualification test, starting from the time the Worker requests the Qualification.
*)answer_key : string_ option;The answers to the Qualification test specified in the Test parameter, in the form of an AnswerKey data structure.
Constraints: Must not be longer than 65535 bytes.
Constraints: None. If not specified, you must process Qualification requests manually.
*)test : string_ option;The questions for the Qualification test a Worker must answer correctly to obtain a Qualification of this type. If this parameter is specified, TestDurationInSeconds must also be specified.
Constraints: Must not be longer than 65535 bytes. Must be a QuestionForm data structure. This parameter cannot be specified if AutoGranted is true.
Constraints: None. If not specified, the Worker may request the Qualification without answering any questions.
*)retry_delay_in_seconds : long option;The number of seconds that a Worker must wait after requesting a Qualification of the Qualification type before the worker can retry the Qualification request.
Constraints: None. If not specified, retries are disabled and Workers can request a Qualification of this type only once, even if the Worker has not been granted the Qualification. It is not possible to disable retries for a Qualification type after it has been created with retries enabled. If you want to disable retries, you must delete existing retry-enabled Qualification type and then create a new Qualification type with retries disabled.
*)qualification_type_status : qualification_type_status;The initial status of the Qualification type.
Constraints: Valid values are: Active | Inactive
*)description : string_;A long description for the Qualification type. On the Amazon Mechanical Turk website, the long description is displayed when a Worker examines a Qualification type.
*)keywords : string_ option;One or more words or phrases that describe the Qualification type, separated by commas. The keywords of a type make the type easier to find during a search.
*)name : string_;The name you give to the Qualification type. The type name is used to represent the Qualification to Workers, and to find the type using a Qualification type search. It must be unique across all of your Qualification types.
*)}type nonrec create_hit_with_hit_type_response = {hi_t : hi_t option;Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.
*)}type nonrec hit_layout_parameter = {value : string_;The value substituted for the parameter referenced in the HITLayout.
*)name : string_;The name of the parameter in the HITLayout.
*)}The HITLayoutParameter data structure defines parameter values used with a HITLayout. A HITLayout is a reusable Amazon Mechanical Turk project template used to provide Human Intelligence Task (HIT) question data for CreateHIT.
type nonrec hit_layout_parameter_list = hit_layout_parameter listtype nonrec create_hit_with_hit_type_request = {hit_layout_parameters : hit_layout_parameter_list option;If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.
*)hit_layout_id : entity_id option;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_review_policy : review_policy option;The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.
*)assignment_review_policy : review_policy option;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.
*)unique_request_token : idempotency_token option;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.
*)requester_annotation : string_ option;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.
*)question : string_ option;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.
*)lifetime_in_seconds : long;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 option;The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
*)hit_type_id : entity_id;The HIT type ID you want to create this HIT with.
*)}type nonrec create_hit_type_response = {hit_type_id : entity_id option;The ID of the newly registered HIT type.
*)}type nonrec create_hit_type_request = {qualification_requirements : qualification_requirement_list option;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.
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.
*)keywords : string_ option;One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
*)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.
*)reward : currency_amount;The amount of money the Requester will pay a Worker for successfully completing the HIT.
*)assignment_duration_in_seconds : long;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.
*)auto_approval_delay_in_seconds : long option;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.
*)}type nonrec create_hit_response = {hi_t : hi_t option;Contains the newly created HIT data. For a description of the HIT data structure as it appears in responses, see the HIT Data Structure documentation.
*)}type nonrec create_hit_request = {hit_layout_parameters : hit_layout_parameter_list option;If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.
*)hit_layout_id : entity_id option;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_review_policy : review_policy option;The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.
*)assignment_review_policy : review_policy option;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.
*)unique_request_token : idempotency_token option;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.
*)qualification_requirements : qualification_requirement_list option;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.
requester_annotation : string_ option;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.
*)question : string_ option;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.
*)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.
*)keywords : string_ option;One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
*)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.
*)reward : currency_amount;The amount of money the Requester will pay a Worker for successfully completing the HIT.
*)assignment_duration_in_seconds : long;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.
*)lifetime_in_seconds : long;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.
*)auto_approval_delay_in_seconds : long option;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.
*)max_assignments : integer option;The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
*)}type nonrec create_additional_assignments_for_hit_request = {unique_request_token : idempotency_token option;A unique identifier for this request, which allows you to retry the call on error without extending the HIT multiple times. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the extend HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.
number_of_additional_assignments : integer;The number of additional assignments to request for this HIT.
*)hit_id : entity_id;The ID of the HIT to extend.
*)}type nonrec associate_qualification_with_worker_request = {send_notification : boolean_ option;Specifies whether to send a notification email message to the Worker saying that the qualification was assigned to the Worker. Note: this is true by default.
*)integer_value : integer option;The value of the Qualification to assign.
*)worker_id : customer_id;The ID of the Worker to whom the Qualification is being assigned. Worker IDs are included with submitted HIT assignments and Qualification requests.
*)qualification_type_id : entity_id;The ID of the Qualification type to use for the assigned Qualification.
*)}type nonrec approve_assignment_request = {override_rejection : boolean_ option;A flag indicating that an assignment should be approved even if it was previously rejected. Defaults to False.
requester_feedback : string_ option;A message for the Worker, which the Worker can see in the Status section of the web site.
*)assignment_id : entity_id;The ID of the assignment. The assignment must correspond to a HIT created by the Requester.
*)}type nonrec accept_qualification_request_request = {integer_value : integer option;The value of the Qualification. You can omit this value if you are using the presence or absence of the Qualification as the basis for a HIT requirement.
*)qualification_request_id : string_;The ID of the Qualification request, as returned by the GetQualificationRequests operation.
}