You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MTurk::Types::ListBonusPaymentsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb

Overview

Note:

When making an API call, you may pass ListBonusPaymentsRequest data as a hash:

{
  hit_id: "EntityId",
  assignment_id: "EntityId",
  next_token: "PaginationToken",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_idString

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

Returns:

  • (String)


1485
1486
1487
1488
1489
1490
1491
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1485

class ListBonusPaymentsRequest < Struct.new(
  :hit_id,
  :assignment_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#hit_idString

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

Returns:

  • (String)


1485
1486
1487
1488
1489
1490
1491
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1485

class ListBonusPaymentsRequest < Struct.new(
  :hit_id,
  :assignment_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

Returns:

  • (Integer)


1485
1486
1487
1488
1489
1490
1491
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1485

class ListBonusPaymentsRequest < Struct.new(
  :hit_id,
  :assignment_id,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

Pagination token

Returns:

  • (String)


1485
1486
1487
1488
1489
1490
1491
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 1485

class ListBonusPaymentsRequest < Struct.new(
  :hit_id,
  :assignment_id,
  :next_token,
  :max_results)
  include Aws::Structure
end