Struct aws_sdk_mturk::input::SendBonusInput

#[non_exhaustive]
pub struct SendBonusInput {
    pub worker_id: Option<String>,
    pub bonus_amount: Option<String>,
    pub assignment_id: Option<String>,
    pub reason: Option<String>,
    pub unique_request_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

worker_id: Option<String>

The ID of the Worker being paid the bonus.

bonus_amount: Option<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.

assignment_id: Option<String>

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

reason: Option<String>

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

unique_request_token: Option<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.

Implementations

impl SendBonusInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<SendBonus, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<SendBonus>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SendBonusInput

impl SendBonusInput

pub fn worker_id(&self) -> Option<&str>

The ID of the Worker being paid the bonus.

pub fn bonus_amount(&self) -> Option<&str>

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) -> Option<&str>

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

pub fn reason(&self) -> Option<&str>

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) -> Option<&str>

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 SendBonusInput

fn clone(&self) -> SendBonusInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SendBonusInput

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

Formats the value using the given formatter.

impl PartialEq<SendBonusInput> for SendBonusInput

fn eq(&self, other: &SendBonusInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SendBonusInput) -> bool

This method tests for !=.

impl StructuralPartialEq for SendBonusInput