File Coverage

blib/lib/Paws/SNS/Subscribe.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SNS::Subscribe;
3 1     1   270 use Moose;
  1     1   2  
  1         6  
  1         316  
  1         2  
  1         5  
4             has Endpoint => (is => 'ro', isa => 'Str');
5             has Protocol => (is => 'ro', isa => 'Str', required => 1);
6             has TopicArn => (is => 'ro', isa => 'Str', required => 1);
7              
8 1     1   5535 use MooseX::ClassAttribute;
  1     1   2  
  1         6  
  1         5665  
  1         2  
  1         7  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'Subscribe');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SNS::SubscribeResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'SubscribeResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::SNS::Subscribe - Arguments for method Subscribe on Paws::SNS
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method Subscribe on the
24             Amazon Simple Notification Service service. Use the attributes of this class
25             as arguments to method Subscribe.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Subscribe.
28              
29             As an example:
30              
31             $service_obj->Subscribe(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 Endpoint => Str
39              
40             The endpoint that you want to receive notifications. Endpoints vary by
41             protocol:
42              
43             =over
44              
45             =item *
46              
47             For the C<http> protocol, the endpoint is an URL beginning with
48             "http://"
49              
50             =item *
51              
52             For the C<https> protocol, the endpoint is a URL beginning with
53             "https://"
54              
55             =item *
56              
57             For the C<email> protocol, the endpoint is an email address
58              
59             =item *
60              
61             For the C<email-json> protocol, the endpoint is an email address
62              
63             =item *
64              
65             For the C<sms> protocol, the endpoint is a phone number of an
66             SMS-enabled device
67              
68             =item *
69              
70             For the C<sqs> protocol, the endpoint is the ARN of an Amazon SQS queue
71              
72             =item *
73              
74             For the C<application> protocol, the endpoint is the EndpointArn of a
75             mobile app and device.
76              
77             =item *
78              
79             For the C<lambda> protocol, the endpoint is the ARN of an AWS Lambda
80             function.
81              
82             =back
83              
84              
85              
86              
87             =head2 B<REQUIRED> Protocol => Str
88              
89             The protocol you want to use. Supported protocols include:
90              
91             =over
92              
93             =item *
94              
95             C<http> -- delivery of JSON-encoded message via HTTP POST
96              
97             =item *
98              
99             C<https> -- delivery of JSON-encoded message via HTTPS POST
100              
101             =item *
102              
103             C<email> -- delivery of message via SMTP
104              
105             =item *
106              
107             C<email-json> -- delivery of JSON-encoded message via SMTP
108              
109             =item *
110              
111             C<sms> -- delivery of message via SMS
112              
113             =item *
114              
115             C<sqs> -- delivery of JSON-encoded message to an Amazon SQS queue
116              
117             =item *
118              
119             C<application> -- delivery of JSON-encoded message to an EndpointArn
120             for a mobile app and device.
121              
122             =item *
123              
124             C<lambda> -- delivery of JSON-encoded message to an AWS Lambda
125             function.
126              
127             =back
128              
129              
130              
131              
132             =head2 B<REQUIRED> TopicArn => Str
133              
134             The ARN of the topic you want to subscribe to.
135              
136              
137              
138              
139             =head1 SEE ALSO
140              
141             This class forms part of L<Paws>, documenting arguments for method Subscribe in L<Paws::SNS>
142              
143             =head1 BUGS and CONTRIBUTIONS
144              
145             The source code is located here: https://github.com/pplu/aws-sdk-perl
146              
147             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
148              
149             =cut
150