libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MechanicalTurk.ListAssignmentsForHIT

Description

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.

This operation returns paginated results.

Synopsis

Creating a Request

data ListAssignmentsForHIT Source #

See: newListAssignmentsForHIT smart constructor.

Constructors

ListAssignmentsForHIT' 

Fields

Instances

Instances details
Eq ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Read ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Show ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Generic ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Associated Types

type Rep ListAssignmentsForHIT :: Type -> Type #

NFData ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Methods

rnf :: ListAssignmentsForHIT -> () #

Hashable ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

ToJSON ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

AWSPager ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

AWSRequest ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Associated Types

type AWSResponse ListAssignmentsForHIT #

ToHeaders ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

ToPath ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

ToQuery ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

type Rep ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

type Rep ListAssignmentsForHIT = D1 ('MetaData "ListAssignmentsForHIT" "Amazonka.MechanicalTurk.ListAssignmentsForHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListAssignmentsForHIT'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assignmentStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AssignmentStatus])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "hITId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListAssignmentsForHIT Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

newListAssignmentsForHIT Source #

Create a value of ListAssignmentsForHIT 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:assignmentStatuses:ListAssignmentsForHIT', listAssignmentsForHIT_assignmentStatuses - The status of the assignments to return: Submitted | Approved | Rejected

$sel:nextToken:ListAssignmentsForHIT', listAssignmentsForHIT_nextToken - Pagination token

$sel:maxResults:ListAssignmentsForHIT', listAssignmentsForHIT_maxResults - Undocumented member.

$sel:hITId:ListAssignmentsForHIT', listAssignmentsForHIT_hITId - The ID of the HIT.

Request Lenses

listAssignmentsForHIT_assignmentStatuses :: Lens' ListAssignmentsForHIT (Maybe [AssignmentStatus]) Source #

The status of the assignments to return: Submitted | Approved | Rejected

Destructuring the Response

data ListAssignmentsForHITResponse Source #

See: newListAssignmentsForHITResponse smart constructor.

Constructors

ListAssignmentsForHITResponse' 

Fields

Instances

Instances details
Eq ListAssignmentsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Read ListAssignmentsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Show ListAssignmentsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Generic ListAssignmentsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

Associated Types

type Rep ListAssignmentsForHITResponse :: Type -> Type #

NFData ListAssignmentsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

type Rep ListAssignmentsForHITResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListAssignmentsForHIT

type Rep ListAssignmentsForHITResponse = D1 ('MetaData "ListAssignmentsForHITResponse" "Amazonka.MechanicalTurk.ListAssignmentsForHIT" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "ListAssignmentsForHITResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "assignments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Assignment])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAssignmentsForHITResponse Source #

Create a value of ListAssignmentsForHITResponse 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:nextToken:ListAssignmentsForHIT', listAssignmentsForHITResponse_nextToken - Undocumented member.

$sel:numResults:ListAssignmentsForHITResponse', listAssignmentsForHITResponse_numResults - The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

$sel:assignments:ListAssignmentsForHITResponse', listAssignmentsForHITResponse_assignments - The collection of Assignment data structures returned by this call.

$sel:httpStatus:ListAssignmentsForHITResponse', listAssignmentsForHITResponse_httpStatus - The response's http status code.

Response Lenses

listAssignmentsForHITResponse_numResults :: Lens' ListAssignmentsForHITResponse (Maybe Int) Source #

The number of assignments on the page in the filtered results list, equivalent to the number of assignments returned by this call.

listAssignmentsForHITResponse_assignments :: Lens' ListAssignmentsForHITResponse (Maybe [Assignment]) Source #

The collection of Assignment data structures returned by this call.