MTurk / Paginator / ListBonusPayments

ListBonusPayments

class MTurk.Paginator.ListBonusPayments

paginator = client.get_paginator('list_bonus_payments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MTurk.Client.list_bonus_payments().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    HITId='string',
    AssignmentId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• HITId (string) – 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 (string) – 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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'NumResults': 123,
    'BonusPayments': [
        {
            'WorkerId': 'string',
            'BonusAmount': 'string',
            'AssignmentId': 'string',
            'Reason': 'string',
            'GrantTime': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) –

  • NumResults (integer) –

    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.

  • BonusPayments (list) –

    A successful request to the ListBonusPayments operation returns a list of BonusPayment objects.

    • (dict) –

      An object representing a Bonus payment paid to a Worker.

      • WorkerId (string) –

        The ID of the Worker to whom the bonus was paid.

      • BonusAmount (string) –

        A string representing a currency amount.

      • AssignmentId (string) –

        The ID of the assignment associated with this bonus payment.

      • Reason (string) –

        The Reason text given when the bonus was granted, if any.

      • GrantTime (datetime) –

        The date and time of when the bonus was granted.