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

Class: Aws::MTurk::Types::SendBonusRequest

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 SendBonusRequest data as a hash:

{
  worker_id: "CustomerId", # required
  bonus_amount: "CurrencyAmount", # required
  assignment_id: "EntityId", # required
  reason: "String", # required
  unique_request_token: "IdempotencyToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#assignment_idString

The ID of the assignment for which this bonus is paid.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2845

class SendBonusRequest < Struct.new(
  :worker_id,
  :bonus_amount,
  :assignment_id,
  :reason,
  :unique_request_token)
  include Aws::Structure
end

#bonus_amountString

The Bonus amount is a US Dollar amount specified using a string (for example, "5" represents $5.00 USD and "101.42" represents $101.42 USD). Do not include currency symbols or currency codes.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2845

class SendBonusRequest < Struct.new(
  :worker_id,
  :bonus_amount,
  :assignment_id,
  :reason,
  :unique_request_token)
  include Aws::Structure
end

#reasonString

A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2845

class SendBonusRequest < Struct.new(
  :worker_id,
  :bonus_amount,
  :assignment_id,
  :reason,
  :unique_request_token)
  include Aws::Structure
end

#unique_request_tokenString

A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the bonus already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return an error with a message containing the request ID.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2845

class SendBonusRequest < Struct.new(
  :worker_id,
  :bonus_amount,
  :assignment_id,
  :reason,
  :unique_request_token)
  include Aws::Structure
end

#worker_idString

The ID of the Worker being paid the bonus.

Returns:

  • (String)


2845
2846
2847
2848
2849
2850
2851
2852
# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2845

class SendBonusRequest < Struct.new(
  :worker_id,
  :bonus_amount,
  :assignment_id,
  :reason,
  :unique_request_token)
  include Aws::Structure
end