NAME

Paws::MTurk::SendBonus - Arguments for method SendBonus on Paws::MTurk

DESCRIPTION

This class represents the parameters used for calling the method SendBonus on the Amazon Mechanical Turk service. Use the attributes of this class as arguments to method SendBonus.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendBonus.

SYNOPSIS

    my $mturk-requester = Paws->service('MTurk');
    my $SendBonusResponse = $mturk -requester->SendBonus(
      AssignmentId       => 'MyEntityId',
      BonusAmount        => 'MyCurrencyAmount',
      Reason             => 'MyString',
      WorkerId           => 'MyCustomerId',
      UniqueRequestToken => 'MyIdempotencyToken',    # OPTIONAL
    );

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/mturk-requester/SendBonus

ATTRIBUTES

REQUIRED AssignmentId => Str

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

REQUIRED BonusAmount => 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.

REQUIRED Reason => Str

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

UniqueRequestToken => 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.

REQUIRED WorkerId => Str

The ID of the Worker being paid the bonus.

SEE ALSO

This class forms part of Paws, documenting arguments for method SendBonus in Paws::MTurk

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues