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.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

Creating a Request

data ListBonusPayments Source #

See: newListBonusPayments smart constructor.

Constructors

ListBonusPayments' 

Fields

  • nextToken :: Maybe Text

    Pagination token

  • hITId :: Maybe Text

    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

  • assignmentId :: Maybe Text

    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

  • maxResults :: Maybe Natural
     

Instances

Instances details
Eq ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Read ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Show ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Generic ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Associated Types

type Rep ListBonusPayments :: Type -> Type #

NFData ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Methods

rnf :: ListBonusPayments -> () #

Hashable ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

ToJSON ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

AWSPager ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

AWSRequest ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Associated Types

type AWSResponse ListBonusPayments #

ToHeaders ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

ToPath ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

ToQuery ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

type Rep ListBonusPayments Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

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

Defined in Amazonka.MechanicalTurk.ListBonusPayments

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_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

Destructuring the Response

data ListBonusPaymentsResponse Source #

See: newListBonusPaymentsResponse smart constructor.

Constructors

ListBonusPaymentsResponse' 

Fields

Instances

Instances details
Eq ListBonusPaymentsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Read ListBonusPaymentsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Show ListBonusPaymentsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Generic ListBonusPaymentsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

Associated Types

type Rep ListBonusPaymentsResponse :: Type -> Type #

NFData ListBonusPaymentsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

type Rep ListBonusPaymentsResponse Source # 
Instance details

Defined in Amazonka.MechanicalTurk.ListBonusPayments

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

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_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.