assignments_for_hits

Creates, updates, deletes, gets or lists an assignments_for_hits resource.

Overview

Name	assignments_for_hits
Type	Resource
Id	aws.mturk.assignments_for_hits

Fields

The following fields are returned by SELECT queries:

list_assignments_for_hit

Name	Datatype	Description
accept_time	string (date-time)	The date and time the Worker accepted the assignment.
answer	string	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.
approval_time	string (date-time)	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.
assignment_id	string	A unique identifier for the assignment. (pattern: <code>^[A-Z0-9]+$</code>)
assignment_status	string	The status of the assignment. (Submitted, Approved, Rejected)
auto_approval_time	string (date-time)	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.
deadline	string (date-time)	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.
hit_id	string	The ID of the HIT. (pattern: <code>^[A-Z0-9]+$</code>)
rejection_time	string (date-time)	If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.
requester_feedback	string	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.
submit_time	string (date-time)	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.
worker_id	string	The ID of the Worker who accepted the HIT. (pattern: <code>^A[A-Z0-9]+$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_assignments_for_hit	select	region		The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.
create_additional_assignments_for_hit	insert	region, HITId, NumberOfAdditionalAssignments		The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments, specify the number of additional assignments. HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_assignments_for_hit

The ListAssignmentsForHIT operation retrieves completed assignments for a HIT. You can use this operation to retrieve the results for a HIT. You can get assignments for a HIT at any time, even if the HIT is not yet Reviewable. If a HIT requested multiple assignments, and has received some results but has not yet become Reviewable, you can still retrieve the partial results with this operation. Use the AssignmentStatus parameter to control which set of assignments for a HIT are returned. The ListAssignmentsForHIT operation can return submitted assignments awaiting approval, or it can return assignments that have already been approved or rejected. You can set AssignmentStatus=Approved,Rejected to get assignments that have already been approved and rejected together in one result set. Only the Requester who created the HIT can retrieve the assignments for that HIT. Results are sorted and divided into numbered pages and the operation returns a single page of results. You can use the parameters of the operation to control sorting and pagination.

SELECT
accept_time,
answer,
approval_time,
assignment_id,
assignment_status,
auto_approval_time,
deadline,
hit_id,
rejection_time,
requester_feedback,
submit_time,
worker_id
FROM aws.mturk.assignments_for_hits
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_additional_assignments_for_hit

The CreateAdditionalAssignmentsForHIT operation increases the maximum number of assignments of an existing HIT. To extend the maximum number of assignments, specify the number of additional assignments. HITs created with fewer than 10 assignments cannot be extended to have 10 or more assignments. Attempting to add assignments in a way that brings the total number of assignments for a HIT from fewer than 10 assignments to 10 or more assignments will result in an AWS.MechanicalTurk.InvalidMaximumAssignmentsIncrease exception. HITs that were created before July 22, 2015 cannot be extended. Attempting to extend HITs that were created before July 22, 2015 will result in an AWS.MechanicalTurk.HITTooOldForExtension exception.

INSERT INTO aws.mturk.assignments_for_hits (
HITId,
NumberOfAdditionalAssignments,
UniqueRequestToken,
region
)
SELECT 
'{{ HITId }}' /* required */,
{{ NumberOfAdditionalAssignments }} /* required */,
'{{ UniqueRequestToken }}',
'{{ region }}'
;

Manifest

# Description fields are for documentation purposes
- name: assignments_for_hits
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the assignments_for_hits resource.
  - name: HITId
    value: "{{ HITId }}"
    description: |
      The ID of the HIT to extend.
  - name: NumberOfAdditionalAssignments
    value: {{ NumberOfAdditionalAssignments }}
    description: |
      The number of additional assignments to request for this HIT.
  - name: UniqueRequestToken
    value: "{{ UniqueRequestToken }}"
    description: |
      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.