amazonka-mechanicalturk-2.0: Amazon Mechanical Turk SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.MechanicalTurk.Types.Assignment

Description

 
Synopsis

Documentation

data Assignment Source #

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.

See: newAssignment smart constructor.

Constructors

Assignment' 

Fields

  • acceptTime :: Maybe POSIX

    The date and time the Worker accepted the assignment.

  • answer :: Maybe Text

    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.

  • approvalTime :: Maybe POSIX

    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.

  • assignmentId :: Maybe Text

    A unique identifier for the assignment.

  • assignmentStatus :: Maybe AssignmentStatus

    The status of the assignment.

  • autoApprovalTime :: Maybe POSIX

    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 :: Maybe POSIX

    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.

  • hITId :: Maybe Text

    The ID of the HIT.

  • rejectionTime :: Maybe POSIX

    If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

  • requesterFeedback :: Maybe Text

    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.

  • submitTime :: Maybe POSIX

    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.

  • workerId :: Maybe Text

    The ID of the Worker who accepted the HIT.

Instances

Instances details
FromJSON Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

Generic Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

Associated Types

type Rep Assignment :: Type -> Type #

Read Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

Show Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

NFData Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

Methods

rnf :: Assignment -> () #

Eq Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

Hashable Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

type Rep Assignment Source # 
Instance details

Defined in Amazonka.MechanicalTurk.Types.Assignment

type Rep Assignment = D1 ('MetaData "Assignment" "Amazonka.MechanicalTurk.Types.Assignment" "amazonka-mechanicalturk-2.0-7Thix2UjvlJINPIH68shk3" 'False) (C1 ('MetaCons "Assignment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "acceptTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "answer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "approvalTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "assignmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "assignmentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssignmentStatus)) :*: S1 ('MetaSel ('Just "autoApprovalTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :*: ((S1 ('MetaSel ('Just "deadline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "hITId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "rejectionTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: (S1 ('MetaSel ('Just "requesterFeedback") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "submitTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "workerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newAssignment :: Assignment Source #

Create a value of Assignment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:acceptTime:Assignment', assignment_acceptTime - The date and time the Worker accepted the assignment.

$sel:answer:Assignment', assignment_answer - 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.

$sel:approvalTime:Assignment', assignment_approvalTime - 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.

$sel:assignmentId:Assignment', assignment_assignmentId - A unique identifier for the assignment.

$sel:assignmentStatus:Assignment', assignment_assignmentStatus - The status of the assignment.

$sel:autoApprovalTime:Assignment', assignment_autoApprovalTime - 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.

$sel:deadline:Assignment', assignment_deadline - 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.

$sel:hITId:Assignment', assignment_hITId - The ID of the HIT.

$sel:rejectionTime:Assignment', assignment_rejectionTime - If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

$sel:requesterFeedback:Assignment', assignment_requesterFeedback - 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.

$sel:submitTime:Assignment', assignment_submitTime - 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.

$sel:workerId:Assignment', assignment_workerId - The ID of the Worker who accepted the HIT.

assignment_acceptTime :: Lens' Assignment (Maybe UTCTime) Source #

The date and time the Worker accepted the assignment.

assignment_answer :: Lens' Assignment (Maybe Text) Source #

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.

assignment_approvalTime :: Lens' Assignment (Maybe UTCTime) Source #

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_assignmentId :: Lens' Assignment (Maybe Text) Source #

A unique identifier for the assignment.

assignment_autoApprovalTime :: Lens' Assignment (Maybe UTCTime) Source #

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_deadline :: Lens' Assignment (Maybe UTCTime) Source #

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.

assignment_rejectionTime :: Lens' Assignment (Maybe UTCTime) Source #

If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.

assignment_requesterFeedback :: Lens' Assignment (Maybe Text) Source #

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.

assignment_submitTime :: Lens' Assignment (Maybe UTCTime) Source #

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.

assignment_workerId :: Lens' Assignment (Maybe Text) Source #

The ID of the Worker who accepted the HIT.