File Coverage

blib/lib/Paws/MTurk/NotificationSpecification.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::MTurk::NotificationSpecification;
2 1     1   495 use Moose;
  1         3  
  1         7  
3             has Destination => (is => 'ro', isa => 'Str', required => 1);
4             has EventTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has Transport => (is => 'ro', isa => 'Str', required => 1);
6             has Version => (is => 'ro', isa => 'Str');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::MTurk::NotificationSpecification
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::MTurk::NotificationSpecification object:
25              
26             $service_obj->Method(Att1 => { Destination => $value, ..., Version => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::MTurk::NotificationSpecification object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->Destination
34              
35             =head1 DESCRIPTION
36              
37             The NotificationSpecification data structure describes a HIT event
38             notification for a HIT type.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> Destination => Str
44              
45             The destination for notification messages. or email notifications (if
46             Transport is Email), this is an email address. For Amazon Simple Queue
47             Service (Amazon SQS) notifications (if Transport is SQS), this is the
48             URL for your Amazon SQS queue.
49              
50              
51             =head2 EventTypes => ArrayRef[Str|Undef]
52              
53             The list of events that should cause notifications to be sent. Valid
54             Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned |
55             AssignmentSubmitted | AssignmentRejected | AssignmentApproved |
56             HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired |
57             Ping. The Ping event is only valid for the SendTestEventNotification
58             operation.
59              
60              
61             =head2 B<REQUIRED> Transport => Str
62              
63             The method Amazon Mechanical Turk uses to send the notification. Valid
64             Values: Email | SQS.
65              
66              
67             =head2 Version => Str
68              
69             The version of the Notification API to use. Valid value is 2006-05-05.
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, describing an object used in L<Paws::MTurk>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84