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

Inherits:

Struct

• Object
• Struct
• Aws::MTurk::Types::SendBonusRequest

Defined in:

gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2443

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

#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.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2443

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

#reason ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2443

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

#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.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2443

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

#worker_id ⇒ String

The ID of the Worker being paid the bonus.

Returns:

• (String)

# File 'gems/aws-sdk-mturk/lib/aws-sdk-mturk/types.rb', line 2443

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