Skip to content

Assignment

Source code in docs_src/capo_mturk/types/assignment.py
class Assignment(TypedDict, closed=True):
    assignment_id: NotRequired["capo_mturk.types.entity_id.EntityId"]
    """<p> A unique identifier for the assignment.</p>"""
    worker_id: NotRequired["capo_mturk.types.customer_id.CustomerId"]
    """<p> The ID of the Worker who accepted the HIT.</p>"""
    hit_id: NotRequired["capo_mturk.types.entity_id.EntityId"]
    """<p> The ID of the HIT.</p>"""
    assignment_status: NotRequired[
        "capo_mturk.types.assignment_status.AssignmentStatus"
    ]
    """<p> The status of the assignment.</p>"""
    auto_approval_time: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> 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.</p>"""
    accept_time: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> The date and time the Worker accepted the assignment.</p>"""
    submit_time: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> 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.</p>"""
    approval_time: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> 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.</p>"""
    rejection_time: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.</p>"""
    deadline: NotRequired["capo_mturk.types.timestamp.Timestamp"]
    """<p> 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.</p>"""
    answer: NotRequired["capo_mturk.types.string.String"]
    """<p> 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.</p>"""
    requester_feedback: NotRequired["capo_mturk.types.string.String"]
    """<p> 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.</p>"""

accept_time instance-attribute

accept_time: NotRequired[Timestamp]

The date and time the Worker accepted the assignment.

answer instance-attribute

answer: NotRequired[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 instance-attribute

approval_time: NotRequired[Timestamp]

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 instance-attribute

assignment_id: NotRequired[EntityId]

A unique identifier for the assignment.

assignment_status instance-attribute

assignment_status: NotRequired[AssignmentStatus]

The status of the assignment.

auto_approval_time instance-attribute

auto_approval_time: NotRequired[Timestamp]

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 instance-attribute

deadline: NotRequired[Timestamp]

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 instance-attribute

hit_id: NotRequired[EntityId]

The ID of the HIT.

rejection_time instance-attribute

rejection_time: NotRequired[Timestamp]

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 instance-attribute

requester_feedback: NotRequired[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 instance-attribute

submit_time: NotRequired[Timestamp]

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 instance-attribute

worker_id: NotRequired[CustomerId]

The ID of the Worker who accepted the HIT.