| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.MechanicalTurk.ListBonusPayments
Description
The ListBonusPayments operation retrieves the amounts of bonuses you
have paid to Workers for a given HIT or assignment.
This operation returns paginated results.
Synopsis
- data ListBonusPayments = ListBonusPayments' {}
- newListBonusPayments :: ListBonusPayments
- listBonusPayments_nextToken :: Lens' ListBonusPayments (Maybe Text)
- listBonusPayments_hITId :: Lens' ListBonusPayments (Maybe Text)
- listBonusPayments_assignmentId :: Lens' ListBonusPayments (Maybe Text)
- listBonusPayments_maxResults :: Lens' ListBonusPayments (Maybe Natural)
- data ListBonusPaymentsResponse = ListBonusPaymentsResponse' {
- bonusPayments :: Maybe [BonusPayment]
- nextToken :: Maybe Text
- numResults :: Maybe Int
- httpStatus :: Int
- newListBonusPaymentsResponse :: Int -> ListBonusPaymentsResponse
- listBonusPaymentsResponse_bonusPayments :: Lens' ListBonusPaymentsResponse (Maybe [BonusPayment])
- listBonusPaymentsResponse_nextToken :: Lens' ListBonusPaymentsResponse (Maybe Text)
- listBonusPaymentsResponse_numResults :: Lens' ListBonusPaymentsResponse (Maybe Int)
- listBonusPaymentsResponse_httpStatus :: Lens' ListBonusPaymentsResponse Int
Creating a Request
data ListBonusPayments Source #
See: newListBonusPayments smart constructor.
Constructors
| ListBonusPayments' | |
Fields
| |
Instances
newListBonusPayments :: ListBonusPayments Source #
Create a value of ListBonusPayments 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:ListBonusPayments', listBonusPayments_nextToken - Pagination token
$sel:hITId:ListBonusPayments', listBonusPayments_hITId - The ID of the HIT associated with the bonus payments to retrieve. If not
specified, all bonus payments for all assignments for the given HIT are
returned. Either the HITId parameter or the AssignmentId parameter must
be specified
$sel:assignmentId:ListBonusPayments', listBonusPayments_assignmentId - The ID of the assignment associated with the bonus payments to retrieve.
If specified, only bonus payments for the given assignment are returned.
Either the HITId parameter or the AssignmentId parameter must be
specified
$sel:maxResults:ListBonusPayments', listBonusPayments_maxResults - Undocumented member.
Request Lenses
listBonusPayments_nextToken :: Lens' ListBonusPayments (Maybe Text) Source #
Pagination token
listBonusPayments_hITId :: Lens' ListBonusPayments (Maybe Text) Source #
The ID of the HIT associated with the bonus payments to retrieve. If not specified, all bonus payments for all assignments for the given HIT are returned. Either the HITId parameter or the AssignmentId parameter must be specified
listBonusPayments_assignmentId :: Lens' ListBonusPayments (Maybe Text) Source #
The ID of the assignment associated with the bonus payments to retrieve. If specified, only bonus payments for the given assignment are returned. Either the HITId parameter or the AssignmentId parameter must be specified
listBonusPayments_maxResults :: Lens' ListBonusPayments (Maybe Natural) Source #
Undocumented member.
Destructuring the Response
data ListBonusPaymentsResponse Source #
See: newListBonusPaymentsResponse smart constructor.
Constructors
| ListBonusPaymentsResponse' | |
Fields
| |
Instances
newListBonusPaymentsResponse Source #
Create a value of ListBonusPaymentsResponse 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:bonusPayments:ListBonusPaymentsResponse', listBonusPaymentsResponse_bonusPayments - A successful request to the ListBonusPayments operation returns a list
of BonusPayment objects.
$sel:nextToken:ListBonusPayments', listBonusPaymentsResponse_nextToken - Undocumented member.
$sel:numResults:ListBonusPaymentsResponse', listBonusPaymentsResponse_numResults - The number of bonus payments on this page in the filtered results list,
equivalent to the number of bonus payments being returned by this call.
$sel:httpStatus:ListBonusPaymentsResponse', listBonusPaymentsResponse_httpStatus - The response's http status code.
Response Lenses
listBonusPaymentsResponse_bonusPayments :: Lens' ListBonusPaymentsResponse (Maybe [BonusPayment]) Source #
A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.
listBonusPaymentsResponse_nextToken :: Lens' ListBonusPaymentsResponse (Maybe Text) Source #
Undocumented member.
listBonusPaymentsResponse_numResults :: Lens' ListBonusPaymentsResponse (Maybe Int) Source #
The number of bonus payments on this page in the filtered results list, equivalent to the number of bonus payments being returned by this call.
listBonusPaymentsResponse_httpStatus :: Lens' ListBonusPaymentsResponse Int Source #
The response's http status code.