« blib/lib/Paws/MTurk/SendBonusResponse.pm
↑ Summary
blib/lib/Paws/MTurk/SendTestEventNotificationResponse.pm »
| 1 | |||
| 2 | package Paws::MTurk::SendTestEventNotification; | ||
| 3 | use Moose; | ||
| 4 | has Notification => (is => 'ro', isa => 'Paws::MTurk::NotificationSpecification', required => 1); | ||
| 5 | has TestEventType => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SendTestEventNotification'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MTurk::SendTestEventNotificationResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::MTurk::SendTestEventNotification - Arguments for method SendTestEventNotification on L<Paws::MTurk> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method SendTestEventNotification on the | ||
| 23 | L<Amazon Mechanical Turk|Paws::MTurk> service. Use the attributes of this class | ||
| 24 | as arguments to method SendTestEventNotification. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SendTestEventNotification. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $mturk-requester = Paws->service('MTurk'); | ||
| 31 | my $SendTestEventNotificationResponse = | ||
| 32 | $mturk -requester->SendTestEventNotification( | ||
| 33 | Notification => { | ||
| 34 | Destination => 'MyString', | ||
| 35 | EventTypes => [ | ||
| 36 | 'AssignmentAccepted', | ||
| 37 | ... # values: AssignmentAccepted, AssignmentAbandoned, AssignmentReturned, AssignmentSubmitted, AssignmentRejected, AssignmentApproved, HITCreated, HITExpired, HITReviewable, HITExtended, HITDisposed, Ping | ||
| 38 | ], | ||
| 39 | Transport => 'Email', # values: Email, SQS, SNS | ||
| 40 | Version => 'MyString', | ||
| 41 | |||
| 42 | }, | ||
| 43 | TestEventType => 'AssignmentAccepted', | ||
| 44 | |||
| 45 | ); | ||
| 46 | |||
| 47 | 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. | ||
| 48 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/mturk-requester/SendTestEventNotification> | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> Notification => L<Paws::MTurk::NotificationSpecification> | ||
| 54 | |||
| 55 | The notification specification to test. This value is identical to the | ||
| 56 | value you would provide to the UpdateNotificationSettings operation | ||
| 57 | when you establish the notification specification for a HIT type. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> TestEventType => Str | ||
| 62 | |||
| 63 | The event to simulate to test the notification specification. This | ||
| 64 | event is included in the test message even if the notification | ||
| 65 | specification does not include the event type. The notification | ||
| 66 | specification does not filter out the test event. | ||
| 67 | |||
| 68 | Valid values are: C<"AssignmentAccepted">, C<"AssignmentAbandoned">, C<"AssignmentReturned">, C<"AssignmentSubmitted">, C<"AssignmentRejected">, C<"AssignmentApproved">, C<"HITCreated">, C<"HITExpired">, C<"HITReviewable">, C<"HITExtended">, C<"HITDisposed">, C<"Ping"> | ||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method SendTestEventNotification in L<Paws::MTurk> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |