Struct aws_sdk_mturk::client::fluent_builders::SendBonus

pub struct SendBonus { /* private fields */ }

Fluent builder constructing a request to SendBonus.

The SendBonus operation issues a payment of money from your account to a Worker. This payment happens separately from the reward you pay to the Worker when you approve the Worker's assignment. The SendBonus operation requires the Worker's ID and the assignment ID as parameters to initiate payment of the bonus. You must include a message that explains the reason for the bonus payment, as the Worker may not be expecting the payment. Amazon Mechanical Turk collects a fee for bonus payments, similar to the HIT listing fee. This operation fails if your account does not have enough funds to pay for both the bonus and the fees.

Implementations

impl SendBonus

pub async fn send(self) -> Result<SendBonusOutput, SdkError<SendBonusError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn worker_id(self, input: impl Into<String>) -> Self

The ID of the Worker being paid the bonus.

pub fn set_worker_id(self, input: Option<String>) -> Self

The ID of the Worker being paid the bonus.

pub fn bonus_amount(self, input: impl Into<String>) -> Self

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.

pub fn set_bonus_amount(self, input: Option<String>) -> Self

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.

pub fn assignment_id(self, input: impl Into<String>) -> Self

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

pub fn set_assignment_id(self, input: Option<String>) -> Self

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

pub fn reason(self, input: impl Into<String>) -> Self

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

pub fn set_reason(self, input: Option<String>) -> Self

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

pub fn unique_request_token(self, input: impl Into<String>) -> Self

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.

pub fn set_unique_request_token(self, input: Option<String>) -> Self

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.

Trait Implementations

impl Clone for SendBonus

fn clone(&self) -> SendBonus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SendBonus

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.