| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
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
- data ListAssignmentsForHIT = ListAssignmentsForHIT' {}
- newListAssignmentsForHIT :: Text -> ListAssignmentsForHIT
- listAssignmentsForHIT_assignmentStatuses :: Lens' ListAssignmentsForHIT (Maybe [AssignmentStatus])
- listAssignmentsForHIT_maxResults :: Lens' ListAssignmentsForHIT (Maybe Natural)
- listAssignmentsForHIT_nextToken :: Lens' ListAssignmentsForHIT (Maybe Text)
- listAssignmentsForHIT_hITId :: Lens' ListAssignmentsForHIT Text
- data ListAssignmentsForHITResponse = ListAssignmentsForHITResponse' {
- assignments :: Maybe [Assignment]
- nextToken :: Maybe Text
- numResults :: Maybe Int
- httpStatus :: Int
- newListAssignmentsForHITResponse :: Int -> ListAssignmentsForHITResponse
- listAssignmentsForHITResponse_assignments :: Lens' ListAssignmentsForHITResponse (Maybe [Assignment])
- listAssignmentsForHITResponse_nextToken :: Lens' ListAssignmentsForHITResponse (Maybe Text)
- listAssignmentsForHITResponse_numResults :: Lens' ListAssignmentsForHITResponse (Maybe Int)
- listAssignmentsForHITResponse_httpStatus :: Lens' ListAssignmentsForHITResponse Int
Creating a Request
data ListAssignmentsForHIT Source #
See: newListAssignmentsForHIT smart constructor.
Constructors
| ListAssignmentsForHIT' | |
Fields
| |
Instances
newListAssignmentsForHIT Source #
Arguments
| :: Text | |
| -> ListAssignmentsForHIT |
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:maxResults:ListAssignmentsForHIT', listAssignmentsForHIT_maxResults - Undocumented member.
ListAssignmentsForHIT, listAssignmentsForHIT_nextToken - Pagination token
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
listAssignmentsForHIT_maxResults :: Lens' ListAssignmentsForHIT (Maybe Natural) Source #
Undocumented member.
listAssignmentsForHIT_nextToken :: Lens' ListAssignmentsForHIT (Maybe Text) Source #
Pagination token
listAssignmentsForHIT_hITId :: Lens' ListAssignmentsForHIT Text Source #
The ID of the HIT.
Destructuring the Response
data ListAssignmentsForHITResponse Source #
See: newListAssignmentsForHITResponse smart constructor.
Constructors
| ListAssignmentsForHITResponse' | |
Fields
| |
Instances
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:assignments:ListAssignmentsForHITResponse', listAssignmentsForHITResponse_assignments - The collection of Assignment data structures returned by this call.
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:httpStatus:ListAssignmentsForHITResponse', listAssignmentsForHITResponse_httpStatus - The response's http status code.
Response Lenses
listAssignmentsForHITResponse_assignments :: Lens' ListAssignmentsForHITResponse (Maybe [Assignment]) Source #
The collection of Assignment data structures returned by this call.
listAssignmentsForHITResponse_nextToken :: Lens' ListAssignmentsForHITResponse (Maybe Text) Source #
Undocumented member.
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_httpStatus :: Lens' ListAssignmentsForHITResponse Int Source #
The response's http status code.