You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::MTurk::Types::SendBonusRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::MTurk::Types::SendBonusRequest
- Defined in:
- (unknown)
Overview
When passing SendBonusRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
worker_id: "CustomerId", # required
bonus_amount: "CurrencyAmount", # required
assignment_id: "EntityId", # required
reason: "String", # required
unique_request_token: "IdempotencyToken",
}
Instance Attribute Summary collapse
-
#assignment_id ⇒ String
The ID of the assignment for which this bonus is paid.
-
#bonus_amount ⇒ String
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).
-
#reason ⇒ String
A message that explains the reason for the bonus payment.
-
#unique_request_token ⇒ String
A unique identifier for this request, which allows you to retry the call on error without granting multiple bonuses.
-
#worker_id ⇒ String
The ID of the Worker being paid the bonus.
Instance Attribute Details
#assignment_id ⇒ String
The ID of the assignment for which this bonus is paid.
#bonus_amount ⇒ String
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.
#reason ⇒ String
A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.
#unique_request_token ⇒ String
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.
#worker_id ⇒ String
The ID of the Worker being paid the bonus.