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   510 use Moose;
  1         3  
  1         8  
3             has Destination => (is => 'ro', isa => 'Str', required => 1);
4             has EventTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
5             has Transport => (is => 'ro', isa => 'Str', required => 1);
6             has Version => (is => 'ro', isa => 'Str', required => 1);
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 target for notification messages. The DestinationE<rsquo>s format
46             is determined by the specified Transport:
47              
48             =over
49              
50             =item *
51              
52             When Transport is Email, the Destination is your email address.
53              
54             =item *
55              
56             When Transport is SQS, the Destination is your queue URL.
57              
58             =item *
59              
60             When Transport is SNS, the Destination is the ARN of your topic.
61              
62             =back
63              
64              
65              
66             =head2 B<REQUIRED> EventTypes => ArrayRef[Str|Undef]
67              
68             The list of events that should cause notifications to be sent. Valid
69             Values: AssignmentAccepted | AssignmentAbandoned | AssignmentReturned |
70             AssignmentSubmitted | AssignmentRejected | AssignmentApproved |
71             HITCreated | HITExtended | HITDisposed | HITReviewable | HITExpired |
72             Ping. The Ping event is only valid for the SendTestEventNotification
73             operation.
74              
75              
76             =head2 B<REQUIRED> Transport => Str
77              
78             The method Amazon Mechanical Turk uses to send the notification. Valid
79             Values: Email | SQS | SNS.
80              
81              
82             =head2 B<REQUIRED> Version => Str
83              
84             The version of the Notification API to use. Valid value is 2006-05-05.
85              
86              
87              
88             =head1 SEE ALSO
89              
90             This class forms part of L<Paws>, describing an object used in L<Paws::MTurk>
91              
92             =head1 BUGS and CONTRIBUTIONS
93              
94             The source code is located here: https://github.com/pplu/aws-sdk-perl
95              
96             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
97              
98             =cut
99