Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.MechanicalTurk.SendBonus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data SendBonus = SendBonus' {
- uniqueRequestToken :: Maybe Text
- workerId :: Text
- bonusAmount :: Text
- assignmentId :: Text
- reason :: Text
}
newSendBonus :: Text -> Text -> Text -> Text -> SendBonus
sendBonus_uniqueRequestToken :: Lens' SendBonus (Maybe Text)
sendBonus_workerId :: Lens' SendBonus Text
sendBonus_bonusAmount :: Lens' SendBonus Text
sendBonus_assignmentId :: Lens' SendBonus Text
sendBonus_reason :: Lens' SendBonus Text
data SendBonusResponse = SendBonusResponse' {
- httpStatus :: Int
}
newSendBonusResponse :: Int -> SendBonusResponse
sendBonusResponse_httpStatus :: Lens' SendBonusResponse Int

Creating a Request

data SendBonus Source #

See: newSendBonus smart constructor.

Constructors

SendBonus'

Fields

uniqueRequestToken :: Maybe Text
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.
workerId :: Text
The ID of the Worker being paid the bonus.
bonusAmount :: Text
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.
assignmentId :: Text
The ID of the assignment for which this bonus is paid.
reason :: Text
A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

Instances

Instances details

Eq SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods (==) :: SendBonus -> SendBonus -> Bool # (/=) :: SendBonus -> SendBonus -> Bool #
Read SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods readsPrec :: Int -> ReadS SendBonus # readList :: ReadS [SendBonus] # readPrec :: ReadPrec SendBonus # readListPrec :: ReadPrec [SendBonus] #
Show SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods showsPrec :: Int -> SendBonus -> ShowS # show :: SendBonus -> String # showList :: [SendBonus] -> ShowS #
Generic SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Associated Types type Rep SendBonus :: Type -> Type # Methods from :: SendBonus -> Rep SendBonus x # to :: Rep SendBonus x -> SendBonus #
NFData SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods rnf :: SendBonus -> () #
Hashable SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods hashWithSalt :: Int -> SendBonus -> Int # hash :: SendBonus -> Int #
ToJSON SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods toJSON :: SendBonus -> Value # toEncoding :: SendBonus -> Encoding # toJSONList :: [SendBonus] -> Value # toEncodingList :: [SendBonus] -> Encoding #
AWSRequest SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Associated Types type AWSResponse SendBonus # Methods request :: SendBonus -> Request SendBonus # response :: MonadResource m => Logger -> Service -> Proxy SendBonus -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SendBonus))) #
ToHeaders SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods toHeaders :: SendBonus -> [Header] #
ToPath SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods toPath :: SendBonus -> ByteString #
ToQuery SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods toQuery :: SendBonus -> QueryString #
type Rep SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus type Rep SendBonus = D1 ('MetaData "SendBonus" "Amazonka.MechanicalTurk.SendBonus" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "SendBonus'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "uniqueRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "workerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "bonusAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "assignmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "reason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse SendBonus Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus type AWSResponse SendBonus = SendBonusResponse

newSendBonus Source #

Arguments

:: Text	`$sel:workerId:SendBonus'`
-> Text	`$sel:bonusAmount:SendBonus'`
-> Text	`$sel:assignmentId:SendBonus'`
-> Text	`$sel:reason:SendBonus'`
-> SendBonus

Create a value of SendBonus with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:uniqueRequestToken:SendBonus', sendBonus_uniqueRequestToken - 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.

$sel:workerId:SendBonus', sendBonus_workerId - The ID of the Worker being paid the bonus.

$sel:bonusAmount:SendBonus', sendBonus_bonusAmount - 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.

$sel:assignmentId:SendBonus', sendBonus_assignmentId - The ID of the assignment for which this bonus is paid.

$sel:reason:SendBonus', sendBonus_reason - A message that explains the reason for the bonus payment. The Worker receiving the bonus can see this message.

Request Lenses

sendBonus_uniqueRequestToken :: Lens' SendBonus (Maybe Text) Source #

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.

sendBonus_workerId :: Lens' SendBonus Text Source #

The ID of the Worker being paid the bonus.

sendBonus_bonusAmount :: Lens' SendBonus Text Source #

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.

sendBonus_assignmentId :: Lens' SendBonus Text Source #

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

sendBonus_reason :: Lens' SendBonus Text Source #

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

Destructuring the Response

data SendBonusResponse Source #

See: newSendBonusResponse smart constructor.

Constructors

SendBonusResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SendBonusResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods (==) :: SendBonusResponse -> SendBonusResponse -> Bool # (/=) :: SendBonusResponse -> SendBonusResponse -> Bool #
Read SendBonusResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods readsPrec :: Int -> ReadS SendBonusResponse # readList :: ReadS [SendBonusResponse] # readPrec :: ReadPrec SendBonusResponse # readListPrec :: ReadPrec [SendBonusResponse] #
Show SendBonusResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods showsPrec :: Int -> SendBonusResponse -> ShowS # show :: SendBonusResponse -> String # showList :: [SendBonusResponse] -> ShowS #
Generic SendBonusResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Associated Types type Rep SendBonusResponse :: Type -> Type # Methods from :: SendBonusResponse -> Rep SendBonusResponse x # to :: Rep SendBonusResponse x -> SendBonusResponse #
NFData SendBonusResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus Methods rnf :: SendBonusResponse -> () #
type Rep SendBonusResponse Source #
Instance details Defined in Amazonka.MechanicalTurk.SendBonus type Rep SendBonusResponse = D1 ('MetaData "SendBonusResponse" "Amazonka.MechanicalTurk.SendBonus" "libZSservicesZSamazonka-mechanicalturkZSamazonka-mechanicalturk" 'False) (C1 ('MetaCons "SendBonusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSendBonusResponse Source #

Arguments

:: Int	`$sel:httpStatus:SendBonusResponse'`
-> SendBonusResponse

Create a value of SendBonusResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:httpStatus:SendBonusResponse', sendBonusResponse_httpStatus - The response's http status code.

Response Lenses

sendBonusResponse_httpStatus :: Lens' SendBonusResponse Int Source #

The response's http status code.