blib/lib/Paws/SNS.pm

filter: Statementstmt 16.6% 46 / 276 Branchbran 0.0% 0 / 64 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 30.9% 17 / 55 Podpod 90.3% 47 / 52 totaltotal 24.6% 110 / 447 CC 49 SCAR 34.4
CC
49
Cov
14%
ListAllEndpointsByPlatformApplication
56.0
ListAllOriginationNumbers
56.0
ListAllPhoneNumbersOptedOut
56.0
CRAP 31.2
« blib/lib/Paws/Polly.pm ↑ Summary lib/Paws/ElasticTranscoder.pm »
1 package Paws::SNS;
2 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 12 ▶ sub service { 'sns' }
Subroutine service: called CC=1 SCAR=0.0
Pod undocumented
4 1 ▶ sub signing_name { 'sns' }
Subroutine signing_name: called CC=1 SCAR=0.0
Pod undocumented
5 1 ▶ sub version { '2010-03-31' }
Subroutine version: called CC=1 SCAR=0.0
Pod undocumented
6 0 ▶ sub flattened_arrays { 0 }
Subroutine flattened_arrays: not called CC=1 SCAR=6.9
Pod undocumented
7 2 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 12 ▶ has retry => (is => 'ro', isa => 'HashRef', default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
9 12 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 2 });
11 12 ▶ has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
Subroutine __ANON__: called CC=1 SCAR=0.0
12 12 ] });
13  
14 2 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::QueryCaller';
15  
16
17 1 ▶ sub AddPermission {
Subroutine AddPermission: called CC=1 SCAR=0.0
Pod documented
18 1 my $self = shift;
19 1 my $call_object = $self->new_with_coercions('Paws::SNS::AddPermission', @_);
20 1 return $self->caller->do_call($self, $call_object);
21 }
22 0 ▶ sub CheckIfPhoneNumberIsOptedOut {
Subroutine CheckIfPhoneNumberIsOptedOut: not called CC=1 SCAR=6.9
Pod documented
23 0 my $self = shift;
24 0 my $call_object = $self->new_with_coercions('Paws::SNS::CheckIfPhoneNumberIsOptedOut', @_);
25 0 return $self->caller->do_call($self, $call_object);
26 }
27 1 ▶ sub ConfirmSubscription {
Subroutine ConfirmSubscription: called CC=1 SCAR=0.0
Pod documented
28 1 my $self = shift;
29 1 my $call_object = $self->new_with_coercions('Paws::SNS::ConfirmSubscription', @_);
30 1 return $self->caller->do_call($self, $call_object);
31 }
32 0 ▶ sub CreatePlatformApplication {
Subroutine CreatePlatformApplication: not called CC=1 SCAR=6.9
Pod documented
33 0 my $self = shift;
34 0 my $call_object = $self->new_with_coercions('Paws::SNS::CreatePlatformApplication', @_);
35 0 return $self->caller->do_call($self, $call_object);
36 }
37 0 ▶ sub CreatePlatformEndpoint {
Subroutine CreatePlatformEndpoint: not called CC=1 SCAR=6.9
Pod documented
38 0 my $self = shift;
39 0 my $call_object = $self->new_with_coercions('Paws::SNS::CreatePlatformEndpoint', @_);
40 0 return $self->caller->do_call($self, $call_object);
41 }
42 0 ▶ sub CreateSMSSandboxPhoneNumber {
Subroutine CreateSMSSandboxPhoneNumber: not called CC=1 SCAR=6.9
Pod documented
43 0 my $self = shift;
44 0 my $call_object = $self->new_with_coercions('Paws::SNS::CreateSMSSandboxPhoneNumber', @_);
45 0 return $self->caller->do_call($self, $call_object);
46 }
47 1 ▶ sub CreateTopic {
Subroutine CreateTopic: called CC=1 SCAR=0.0
Pod documented
48 1 my $self = shift;
49 1 my $call_object = $self->new_with_coercions('Paws::SNS::CreateTopic', @_);
50 1 return $self->caller->do_call($self, $call_object);
51 }
52 0 ▶ sub DeleteEndpoint {
Subroutine DeleteEndpoint: not called CC=1 SCAR=6.9
Pod documented
53 0 my $self = shift;
54 0 my $call_object = $self->new_with_coercions('Paws::SNS::DeleteEndpoint', @_);
55 0 return $self->caller->do_call($self, $call_object);
56 }
57 0 ▶ sub DeletePlatformApplication {
Subroutine DeletePlatformApplication: not called CC=1 SCAR=6.9
Pod documented
58 0 my $self = shift;
59 0 my $call_object = $self->new_with_coercions('Paws::SNS::DeletePlatformApplication', @_);
60 0 return $self->caller->do_call($self, $call_object);
61 }
62 0 ▶ sub DeleteSMSSandboxPhoneNumber {
Subroutine DeleteSMSSandboxPhoneNumber: not called CC=1 SCAR=6.9
Pod documented
63 0 my $self = shift;
64 0 my $call_object = $self->new_with_coercions('Paws::SNS::DeleteSMSSandboxPhoneNumber', @_);
65 0 return $self->caller->do_call($self, $call_object);
66 }
67 0 ▶ sub DeleteTopic {
Subroutine DeleteTopic: not called CC=1 SCAR=6.9
Pod documented
68 0 my $self = shift;
69 0 my $call_object = $self->new_with_coercions('Paws::SNS::DeleteTopic', @_);
70 0 return $self->caller->do_call($self, $call_object);
71 }
72 0 ▶ sub GetEndpointAttributes {
Subroutine GetEndpointAttributes: not called CC=1 SCAR=6.9
Pod documented
73 0 my $self = shift;
74 0 my $call_object = $self->new_with_coercions('Paws::SNS::GetEndpointAttributes', @_);
75 0 return $self->caller->do_call($self, $call_object);
76 }
77 0 ▶ sub GetPlatformApplicationAttributes {
Subroutine GetPlatformApplicationAttributes: not called CC=1 SCAR=6.9
Pod documented
78 0 my $self = shift;
79 0 my $call_object = $self->new_with_coercions('Paws::SNS::GetPlatformApplicationAttributes', @_);
80 0 return $self->caller->do_call($self, $call_object);
81 }
82 0 ▶ sub GetSMSAttributes {
Subroutine GetSMSAttributes: not called CC=1 SCAR=6.9
Pod documented
83 0 my $self = shift;
84 0 my $call_object = $self->new_with_coercions('Paws::SNS::GetSMSAttributes', @_);
85 0 return $self->caller->do_call($self, $call_object);
86 }
87 0 ▶ sub GetSMSSandboxAccountStatus {
Subroutine GetSMSSandboxAccountStatus: not called CC=1 SCAR=6.9
Pod documented
88 0 my $self = shift;
89 0 my $call_object = $self->new_with_coercions('Paws::SNS::GetSMSSandboxAccountStatus', @_);
90 0 return $self->caller->do_call($self, $call_object);
91 }
92 1 ▶ sub GetSubscriptionAttributes {
Subroutine GetSubscriptionAttributes: called CC=1 SCAR=0.0
Pod documented
93 1 my $self = shift;
94 1 my $call_object = $self->new_with_coercions('Paws::SNS::GetSubscriptionAttributes', @_);
95 1 return $self->caller->do_call($self, $call_object);
96 }
97 2 ▶ sub GetTopicAttributes {
Subroutine GetTopicAttributes: called CC=1 SCAR=0.0
Pod documented
98 2 my $self = shift;
99 2 my $call_object = $self->new_with_coercions('Paws::SNS::GetTopicAttributes', @_);
100 2 return $self->caller->do_call($self, $call_object);
101 }
102 0 ▶ sub ListEndpointsByPlatformApplication {
Subroutine ListEndpointsByPlatformApplication: not called CC=1 SCAR=6.9
Pod documented
103 0 my $self = shift;
104 0 my $call_object = $self->new_with_coercions('Paws::SNS::ListEndpointsByPlatformApplication', @_);
105 0 return $self->caller->do_call($self, $call_object);
106 }
107 0 ▶ sub ListOriginationNumbers {
Subroutine ListOriginationNumbers: not called CC=1 SCAR=6.9
Pod documented
108 0 my $self = shift;
109 0 my $call_object = $self->new_with_coercions('Paws::SNS::ListOriginationNumbers', @_);
110 0 return $self->caller->do_call($self, $call_object);
111 }
112 0 ▶ sub ListPhoneNumbersOptedOut {
Subroutine ListPhoneNumbersOptedOut: not called CC=1 SCAR=6.9
Pod documented
113 0 my $self = shift;
114 0 my $call_object = $self->new_with_coercions('Paws::SNS::ListPhoneNumbersOptedOut', @_);
115 0 return $self->caller->do_call($self, $call_object);
116 }
117 0 ▶ sub ListPlatformApplications {
Subroutine ListPlatformApplications: not called CC=1 SCAR=6.9
Pod documented
118 0 my $self = shift;
119 0 my $call_object = $self->new_with_coercions('Paws::SNS::ListPlatformApplications', @_);
120 0 return $self->caller->do_call($self, $call_object);
121 }
122 0 ▶ sub ListSMSSandboxPhoneNumbers {
Subroutine ListSMSSandboxPhoneNumbers: not called CC=1 SCAR=6.9
Pod documented
123 0 my $self = shift;
124 0 my $call_object = $self->new_with_coercions('Paws::SNS::ListSMSSandboxPhoneNumbers', @_);
125 0 return $self->caller->do_call($self, $call_object);
126 }
127 1 ▶ sub ListSubscriptions {
Subroutine ListSubscriptions: called CC=1 SCAR=0.0
Pod documented
128 1 my $self = shift;
129 1 my $call_object = $self->new_with_coercions('Paws::SNS::ListSubscriptions', @_);
130 1 return $self->caller->do_call($self, $call_object);
131 }
132 1 ▶ sub ListSubscriptionsByTopic {
Subroutine ListSubscriptionsByTopic: called CC=1 SCAR=0.0
Pod documented
133 1 my $self = shift;
134 1 my $call_object = $self->new_with_coercions('Paws::SNS::ListSubscriptionsByTopic', @_);
135 1 return $self->caller->do_call($self, $call_object);
136 }
137 0 ▶ sub ListTagsForResource {
Subroutine ListTagsForResource: not called CC=1 SCAR=6.9
Pod documented
138 0 my $self = shift;
139 0 my $call_object = $self->new_with_coercions('Paws::SNS::ListTagsForResource', @_);
140 0 return $self->caller->do_call($self, $call_object);
141 }
142 1 ▶ sub ListTopics {
Subroutine ListTopics: called CC=1 SCAR=0.0
Pod documented
143 1 my $self = shift;
144 1 my $call_object = $self->new_with_coercions('Paws::SNS::ListTopics', @_);
145 1 return $self->caller->do_call($self, $call_object);
146 }
147 0 ▶ sub OptInPhoneNumber {
Subroutine OptInPhoneNumber: not called CC=1 SCAR=6.9
Pod documented
148 0 my $self = shift;
149 0 my $call_object = $self->new_with_coercions('Paws::SNS::OptInPhoneNumber', @_);
150 0 return $self->caller->do_call($self, $call_object);
151 }
152 1 ▶ sub Publish {
Subroutine Publish: called CC=1 SCAR=0.0
Pod documented
153 1 my $self = shift;
154 1 my $call_object = $self->new_with_coercions('Paws::SNS::Publish', @_);
155 1 return $self->caller->do_call($self, $call_object);
156 }
157 0 ▶ sub RemovePermission {
Subroutine RemovePermission: not called CC=1 SCAR=6.9
Pod documented
158 0 my $self = shift;
159 0 my $call_object = $self->new_with_coercions('Paws::SNS::RemovePermission', @_);
160 0 return $self->caller->do_call($self, $call_object);
161 }
162 0 ▶ sub SetEndpointAttributes {
Subroutine SetEndpointAttributes: not called CC=1 SCAR=6.9
Pod documented
163 0 my $self = shift;
164 0 my $call_object = $self->new_with_coercions('Paws::SNS::SetEndpointAttributes', @_);
165 0 return $self->caller->do_call($self, $call_object);
166 }
167 1 ▶ sub SetPlatformApplicationAttributes {
Subroutine SetPlatformApplicationAttributes: called CC=1 SCAR=0.0
Pod documented
168 1 my $self = shift;
169 1 my $call_object = $self->new_with_coercions('Paws::SNS::SetPlatformApplicationAttributes', @_);
170 1 return $self->caller->do_call($self, $call_object);
171 }
172 0 ▶ sub SetSMSAttributes {
Subroutine SetSMSAttributes: not called CC=1 SCAR=6.9
Pod documented
173 0 my $self = shift;
174 0 my $call_object = $self->new_with_coercions('Paws::SNS::SetSMSAttributes', @_);
175 0 return $self->caller->do_call($self, $call_object);
176 }
177 0 ▶ sub SetSubscriptionAttributes {
Subroutine SetSubscriptionAttributes: not called CC=1 SCAR=6.9
Pod documented
178 0 my $self = shift;
179 0 my $call_object = $self->new_with_coercions('Paws::SNS::SetSubscriptionAttributes', @_);
180 0 return $self->caller->do_call($self, $call_object);
181 }
182 0 ▶ sub SetTopicAttributes {
Subroutine SetTopicAttributes: not called CC=1 SCAR=6.9
Pod documented
183 0 my $self = shift;
184 0 my $call_object = $self->new_with_coercions('Paws::SNS::SetTopicAttributes', @_);
185 0 return $self->caller->do_call($self, $call_object);
186 }
187 1 ▶ sub Subscribe {
Subroutine Subscribe: called CC=1 SCAR=0.0
Pod documented
188 1 my $self = shift;
189 1 my $call_object = $self->new_with_coercions('Paws::SNS::Subscribe', @_);
190 1 return $self->caller->do_call($self, $call_object);
191 }
192 0 ▶ sub TagResource {
Subroutine TagResource: not called CC=1 SCAR=6.9
Pod documented
193 0 my $self = shift;
194 0 my $call_object = $self->new_with_coercions('Paws::SNS::TagResource', @_);
195 0 return $self->caller->do_call($self, $call_object);
196 }
197 0 ▶ sub Unsubscribe {
Subroutine Unsubscribe: not called CC=1 SCAR=6.9
Pod documented
198 0 my $self = shift;
199 0 my $call_object = $self->new_with_coercions('Paws::SNS::Unsubscribe', @_);
200 0 return $self->caller->do_call($self, $call_object);
201 }
202 0 ▶ sub UntagResource {
Subroutine UntagResource: not called CC=1 SCAR=6.9
Pod documented
203 0 my $self = shift;
204 0 my $call_object = $self->new_with_coercions('Paws::SNS::UntagResource', @_);
205 0 return $self->caller->do_call($self, $call_object);
206 }
207 0 ▶ sub VerifySMSSandboxPhoneNumber {
Subroutine VerifySMSSandboxPhoneNumber: not called CC=1 SCAR=6.9
Pod documented
208 0 my $self = shift;
209 0 my $call_object = $self->new_with_coercions('Paws::SNS::VerifySMSSandboxPhoneNumber', @_);
210 0 return $self->caller->do_call($self, $call_object);
211 }
212
213 0 ▶ sub ListAllEndpointsByPlatformApplication {
Subroutine ListAllEndpointsByPlatformApplication: not called CC=7 SCAR=40.3
Pod documented
214 0 my $self = shift;
215  
216 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
217 0 my $result = $self->ListEndpointsByPlatformApplication(@_);
218 0 my $next_result = $result;
219  
220 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
221 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
222 0 $next_result = $self->ListEndpointsByPlatformApplication(@_, NextToken => $next_result->NextToken);
223 0 push @{ $result->Endpoints }, @{ $next_result->Endpoints };
224 }
225 0 return $result;
226 } else {
227 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
228 0 $callback->($_ => 'Endpoints') foreach (@{ $result->Endpoints });
229 0 $result = $self->ListEndpointsByPlatformApplication(@_, NextToken => $result->NextToken);
230 }
231 0 $callback->($_ => 'Endpoints') foreach (@{ $result->Endpoints });
232 }
233  
234 return undef
235 0 }
236 0 ▶ sub ListAllOriginationNumbers {
Subroutine ListAllOriginationNumbers: not called CC=7 SCAR=40.3
Pod documented
237 0 my $self = shift;
238  
239 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
240 0 my $result = $self->ListOriginationNumbers(@_);
241 0 my $next_result = $result;
242  
243 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
244 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
245 0 $next_result = $self->ListOriginationNumbers(@_, NextToken => $next_result->NextToken);
246 0 push @{ $result->PhoneNumbers }, @{ $next_result->PhoneNumbers };
247 }
248 0 return $result;
249 } else {
250 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
251 0 $callback->($_ => 'PhoneNumbers') foreach (@{ $result->PhoneNumbers });
252 0 $result = $self->ListOriginationNumbers(@_, NextToken => $result->NextToken);
253 }
254 0 $callback->($_ => 'PhoneNumbers') foreach (@{ $result->PhoneNumbers });
255 }
256  
257 return undef
258 0 }
259 0 ▶ sub ListAllPhoneNumbersOptedOut {
Subroutine ListAllPhoneNumbersOptedOut: not called CC=7 SCAR=40.3
Pod documented
260 0 my $self = shift;
261  
262 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
263 0 my $result = $self->ListPhoneNumbersOptedOut(@_);
264 0 my $next_result = $result;
265  
266 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
267 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
268 0 $next_result = $self->ListPhoneNumbersOptedOut(@_, nextToken => $next_result->nextToken);
269 0 push @{ $result->phoneNumbers }, @{ $next_result->phoneNumbers };
270 }
271 0 return $result;
272 } else {
273 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
274 0 $callback->($_ => 'phoneNumbers') foreach (@{ $result->phoneNumbers });
275 0 $result = $self->ListPhoneNumbersOptedOut(@_, nextToken => $result->nextToken);
276 }
277 0 $callback->($_ => 'phoneNumbers') foreach (@{ $result->phoneNumbers });
278 }
279  
280 return undef
281 0 }
282 0 ▶ sub ListAllPlatformApplications {
Subroutine ListAllPlatformApplications: not called CC=7 SCAR=40.3
Pod documented
283 0 my $self = shift;
284  
285 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
286 0 my $result = $self->ListPlatformApplications(@_);
287 0 my $next_result = $result;
288  
289 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
290 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
291 0 $next_result = $self->ListPlatformApplications(@_, NextToken => $next_result->NextToken);
292 0 push @{ $result->PlatformApplications }, @{ $next_result->PlatformApplications };
293 }
294 0 return $result;
295 } else {
296 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
297 0 $callback->($_ => 'PlatformApplications') foreach (@{ $result->PlatformApplications });
298 0 $result = $self->ListPlatformApplications(@_, NextToken => $result->NextToken);
299 }
300 0 $callback->($_ => 'PlatformApplications') foreach (@{ $result->PlatformApplications });
301 }
302  
303 return undef
304 0 }
305 0 ▶ sub ListAllSMSSandboxPhoneNumbers {
Subroutine ListAllSMSSandboxPhoneNumbers: not called CC=7 SCAR=40.3
Pod documented
306 0 my $self = shift;
307  
308 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
309 0 my $result = $self->ListSMSSandboxPhoneNumbers(@_);
310 0 my $next_result = $result;
311  
312 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
313 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
314 0 $next_result = $self->ListSMSSandboxPhoneNumbers(@_, NextToken => $next_result->NextToken);
315 0 push @{ $result->PhoneNumbers }, @{ $next_result->PhoneNumbers };
316 }
317 0 return $result;
318 } else {
319 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
320 0 $callback->($_ => 'PhoneNumbers') foreach (@{ $result->PhoneNumbers });
321 0 $result = $self->ListSMSSandboxPhoneNumbers(@_, NextToken => $result->NextToken);
322 }
323 0 $callback->($_ => 'PhoneNumbers') foreach (@{ $result->PhoneNumbers });
324 }
325  
326 return undef
327 0 }
328 0 ▶ sub ListAllSubscriptions {
Subroutine ListAllSubscriptions: not called CC=7 SCAR=40.3
Pod documented
329 0 my $self = shift;
330  
331 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
332 0 my $result = $self->ListSubscriptions(@_);
333 0 my $next_result = $result;
334  
335 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
336 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
337 0 $next_result = $self->ListSubscriptions(@_, NextToken => $next_result->NextToken);
338 0 push @{ $result->Subscriptions }, @{ $next_result->Subscriptions };
339 }
340 0 return $result;
341 } else {
342 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
343 0 $callback->($_ => 'Subscriptions') foreach (@{ $result->Subscriptions });
344 0 $result = $self->ListSubscriptions(@_, NextToken => $result->NextToken);
345 }
346 0 $callback->($_ => 'Subscriptions') foreach (@{ $result->Subscriptions });
347 }
348  
349 return undef
350 0 }
351 0 ▶ sub ListAllSubscriptionsByTopic {
Subroutine ListAllSubscriptionsByTopic: not called CC=7 SCAR=40.3
Pod documented
352 0 my $self = shift;
353  
354 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
355 0 my $result = $self->ListSubscriptionsByTopic(@_);
356 0 my $next_result = $result;
357  
358 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
359 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
360 0 $next_result = $self->ListSubscriptionsByTopic(@_, NextToken => $next_result->NextToken);
361 0 push @{ $result->Subscriptions }, @{ $next_result->Subscriptions };
362 }
363 0 return $result;
364 } else {
365 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
366 0 $callback->($_ => 'Subscriptions') foreach (@{ $result->Subscriptions });
367 0 $result = $self->ListSubscriptionsByTopic(@_, NextToken => $result->NextToken);
368 }
369 0 $callback->($_ => 'Subscriptions') foreach (@{ $result->Subscriptions });
370 }
371  
372 return undef
373 0 }
374 0 ▶ sub ListAllTopics {
Subroutine ListAllTopics: not called CC=7 SCAR=40.3
Pod documented
375 0 my $self = shift;
376  
377 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
378 0 my $result = $self->ListTopics(@_);
379 0 my $next_result = $result;
380  
381 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
382 0 ▶ while ($next_result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->NextToken) 0 0 0
383 0 $next_result = $self->ListTopics(@_, NextToken => $next_result->NextToken);
384 0 push @{ $result->Topics }, @{ $next_result->Topics };
385 }
386 0 return $result;
387 } else {
388 0 ▶ while ($result->NextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->NextToken) 0 0 0
389 0 $callback->($_ => 'Topics') foreach (@{ $result->Topics });
390 0 $result = $self->ListTopics(@_, NextToken => $result->NextToken);
391 }
392 0 $callback->($_ => 'Topics') foreach (@{ $result->Topics });
393 }
394  
395 return undef
396 0 }
397  
398  
399 0 ▶ sub operations { qw/AddPermission CheckIfPhoneNumberIsOptedOut ConfirmSubscription CreatePlatformApplication CreatePlatformEndpoint CreateSMSSandboxPhoneNumber CreateTopic DeleteEndpoint DeletePlatformApplication DeleteSMSSandboxPhoneNumber DeleteTopic GetEndpointAttributes GetPlatformApplicationAttributes GetSMSAttributes GetSMSSandboxAccountStatus GetSubscriptionAttributes GetTopicAttributes ListEndpointsByPlatformApplication ListOriginationNumbers ListPhoneNumbersOptedOut ListPlatformApplications ListSMSSandboxPhoneNumbers ListSubscriptions ListSubscriptionsByTopic ListTagsForResource ListTopics OptInPhoneNumber Publish RemovePermission SetEndpointAttributes SetPlatformApplicationAttributes SetSMSAttributes SetSubscriptionAttributes SetTopicAttributes Subscribe TagResource Unsubscribe UntagResource VerifySMSSandboxPhoneNumber / }
Subroutine operations: not called CC=1 SCAR=6.9
Pod undocumented
400  
401 2 1;
402  
403 ### main pod documentation begin ###
404  
405 =head1 NAME
406  
407 Paws::SNS - Perl Interface to AWS Amazon Simple Notification Service
408  
409 =head1 SYNOPSIS
410  
411 use Paws;
412  
413 my $obj = Paws->service('SNS');
414 my $res = $obj->Method(
415 Arg1 => $val1,
416 Arg2 => [ 'V1', 'V2' ],
417 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
418 # of the arguments type
419 Arg3 => { Att1 => 'Val1' },
420 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
421 # the constructor of the arguments type
422 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
423 );
424  
425 =head1 DESCRIPTION
426  
427 Amazon Simple Notification Service
428  
429 Amazon Simple Notification Service (Amazon SNS) is a web service that
430 enables you to build distributed web-enabled applications. Applications
431 can use Amazon SNS to easily push real-time notification messages to
432 interested subscribers over multiple delivery protocols. For more
433 information about this product see the Amazon SNS product page
434 (http://aws.amazon.com/sns/). For detailed information about Amazon SNS
435 features and their associated API calls, see the Amazon SNS Developer
436 Guide (https://docs.aws.amazon.com/sns/latest/dg/).
437  
438 For information on the permissions you need to use this API, see
439 Identity and access management in Amazon SNS
440 (https://docs.aws.amazon.com/sns/latest/dg/sns-authentication-and-access-control.html)
441 in the I<Amazon SNS Developer Guide.>
442  
443 We also provide SDKs that enable you to access Amazon SNS from your
444 preferred programming language. The SDKs contain functionality that
445 automatically takes care of tasks such as: cryptographically signing
446 your service requests, retrying requests, and handling error responses.
447 For a list of available SDKs, go to Tools for Amazon Web Services
448 (http://aws.amazon.com/tools/).
449  
450 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/sns-2010-03-31>
451  
452  
453 =head1 METHODS
454  
455 =head2 AddPermission
456  
457 =over
458  
459 =item ActionName => ArrayRef[Str|Undef]
460  
461 =item AWSAccountId => ArrayRef[Str|Undef]
462  
463 =item Label => Str
464  
465 =item TopicArn => Str
466  
467  
468 =back
469  
470 Each argument is described in detail in: L<Paws::SNS::AddPermission>
471  
472 Returns: nothing
473  
474 Adds a statement to a topic's access control policy, granting access
475 for the specified accounts to the specified actions.
476  
477  
478 =head2 CheckIfPhoneNumberIsOptedOut
479  
480 =over
481  
482 =item PhoneNumber => Str
483  
484  
485 =back
486  
487 Each argument is described in detail in: L<Paws::SNS::CheckIfPhoneNumberIsOptedOut>
488  
489 Returns: a L<Paws::SNS::CheckIfPhoneNumberIsOptedOutResponse> instance
490  
491 Accepts a phone number and indicates whether the phone holder has opted
492 out of receiving SMS messages from your account. You cannot send SMS
493 messages to a number that is opted out.
494  
495 To resume sending messages, you can opt in the number by using the
496 C<OptInPhoneNumber> action.
497  
498  
499 =head2 ConfirmSubscription
500  
501 =over
502  
503 =item Token => Str
504  
505 =item TopicArn => Str
506  
507 =item [AuthenticateOnUnsubscribe => Str]
508  
509  
510 =back
511  
512 Each argument is described in detail in: L<Paws::SNS::ConfirmSubscription>
513  
514 Returns: a L<Paws::SNS::ConfirmSubscriptionResponse> instance
515  
516 Verifies an endpoint owner's intent to receive messages by validating
517 the token sent to the endpoint by an earlier C<Subscribe> action. If
518 the token is valid, the action creates a new subscription and returns
519 its Amazon Resource Name (ARN). This call requires an AWS signature
520 only when the C<AuthenticateOnUnsubscribe> flag is set to "true".
521  
522  
523 =head2 CreatePlatformApplication
524  
525 =over
526  
527 =item Attributes => L<Paws::SNS::MapStringToString>
528  
529 =item Name => Str
530  
531 =item Platform => Str
532  
533  
534 =back
535  
536 Each argument is described in detail in: L<Paws::SNS::CreatePlatformApplication>
537  
538 Returns: a L<Paws::SNS::CreatePlatformApplicationResponse> instance
539  
540 Creates a platform application object for one of the supported push
541 notification services, such as APNS and GCM (Firebase Cloud Messaging),
542 to which devices and mobile apps may register. You must specify
543 C<PlatformPrincipal> and C<PlatformCredential> attributes when using
544 the C<CreatePlatformApplication> action.
545  
546 C<PlatformPrincipal> and C<PlatformCredential> are received from the
547 notification service.
548  
549 =over
550  
551 =item *
552  
553 For C<ADM>, C<PlatformPrincipal> is C<client id> and
554 C<PlatformCredential> is C<client secret>.
555  
556 =item *
557  
558 For C<Baidu>, C<PlatformPrincipal> is C<API key> and
559 C<PlatformCredential> is C<secret key>.
560  
561 =item *
562  
563 For C<APNS> and C<APNS_SANDBOX>, C<PlatformPrincipal> is C<SSL
564 certificate> and C<PlatformCredential> is C<private key>.
565  
566 =item *
567  
568 For C<GCM> (Firebase Cloud Messaging), there is no C<PlatformPrincipal>
569 and the C<PlatformCredential> is C<API key>.
570  
571 =item *
572  
573 For C<MPNS>, C<PlatformPrincipal> is C<TLS certificate> and
574 C<PlatformCredential> is C<private key>.
575  
576 =item *
577  
578 For C<WNS>, C<PlatformPrincipal> is C<Package Security Identifier> and
579 C<PlatformCredential> is C<secret key>.
580  
581 =back
582  
583 You can use the returned C<PlatformApplicationArn> as an attribute for
584 the C<CreatePlatformEndpoint> action.
585  
586  
587 =head2 CreatePlatformEndpoint
588  
589 =over
590  
591 =item PlatformApplicationArn => Str
592  
593 =item Token => Str
594  
595 =item [Attributes => L<Paws::SNS::MapStringToString>]
596  
597 =item [CustomUserData => Str]
598  
599  
600 =back
601  
602 Each argument is described in detail in: L<Paws::SNS::CreatePlatformEndpoint>
603  
604 Returns: a L<Paws::SNS::CreateEndpointResponse> instance
605  
606 Creates an endpoint for a device and mobile app on one of the supported
607 push notification services, such as GCM (Firebase Cloud Messaging) and
608 APNS. C<CreatePlatformEndpoint> requires the C<PlatformApplicationArn>
609 that is returned from C<CreatePlatformApplication>. You can use the
610 returned C<EndpointArn> to send a message to a mobile app or by the
611 C<Subscribe> action for subscription to a topic. The
612 C<CreatePlatformEndpoint> action is idempotent, so if the requester
613 already owns an endpoint with the same device token and attributes,
614 that endpoint's ARN is returned without creating a new endpoint. For
615 more information, see Using Amazon SNS Mobile Push Notifications
616 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
617  
618 When using C<CreatePlatformEndpoint> with Baidu, two attributes must be
619 provided: ChannelId and UserId. The token field must also contain the
620 ChannelId. For more information, see Creating an Amazon SNS Endpoint
621 for Baidu
622 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePushBaiduEndpoint.html).
623  
624  
625 =head2 CreateSMSSandboxPhoneNumber
626  
627 =over
628  
629 =item PhoneNumber => Str
630  
631 =item [LanguageCode => Str]
632  
633  
634 =back
635  
636 Each argument is described in detail in: L<Paws::SNS::CreateSMSSandboxPhoneNumber>
637  
638 Returns: a L<Paws::SNS::CreateSMSSandboxPhoneNumberResult> instance
639  
640 Adds a destination phone number to an account in the SMS sandbox and
641 sends a one-time password (OTP) to that phone number.
642  
643 When you start using Amazon SNS to send SMS messages, your account is
644 in the I<SMS sandbox>. The SMS sandbox provides a safe environment for
645 you to try Amazon SNS features without risking your reputation as an
646 SMS sender. While your account is in the SMS sandbox, you can use all
647 of the features of Amazon SNS. However, you can send SMS messages only
648 to verified destination phone numbers. For more information, including
649 how to move out of the sandbox to send messages without restrictions,
650 see SMS sandbox
651 (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the
652 I<Amazon SNS Developer Guide>.
653  
654  
655 =head2 CreateTopic
656  
657 =over
658  
659 =item Name => Str
660  
661 =item [Attributes => L<Paws::SNS::TopicAttributesMap>]
662  
663 =item [Tags => ArrayRef[L<Paws::SNS::Tag>]]
664  
665  
666 =back
667  
668 Each argument is described in detail in: L<Paws::SNS::CreateTopic>
669  
670 Returns: a L<Paws::SNS::CreateTopicResponse> instance
671  
672 Creates a topic to which notifications can be published. Users can
673 create at most 100,000 standard topics (at most 1,000 FIFO topics). For
674 more information, see Creating an Amazon SNS topic
675 (https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html) in
676 the I<Amazon SNS Developer Guide>. This action is idempotent, so if the
677 requester already owns a topic with the specified name, that topic's
678 ARN is returned without creating a new topic.
679  
680  
681 =head2 DeleteEndpoint
682  
683 =over
684  
685 =item EndpointArn => Str
686  
687  
688 =back
689  
690 Each argument is described in detail in: L<Paws::SNS::DeleteEndpoint>
691  
692 Returns: nothing
693  
694 Deletes the endpoint for a device and mobile app from Amazon SNS. This
695 action is idempotent. For more information, see Using Amazon SNS Mobile
696 Push Notifications
697 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
698  
699 When you delete an endpoint that is also subscribed to a topic, then
700 you must also unsubscribe the endpoint from the topic.
701  
702  
703 =head2 DeletePlatformApplication
704  
705 =over
706  
707 =item PlatformApplicationArn => Str
708  
709  
710 =back
711  
712 Each argument is described in detail in: L<Paws::SNS::DeletePlatformApplication>
713  
714 Returns: nothing
715  
716 Deletes a platform application object for one of the supported push
717 notification services, such as APNS and GCM (Firebase Cloud Messaging).
718 For more information, see Using Amazon SNS Mobile Push Notifications
719 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
720  
721  
722 =head2 DeleteSMSSandboxPhoneNumber
723  
724 =over
725  
726 =item PhoneNumber => Str
727  
728  
729 =back
730  
731 Each argument is described in detail in: L<Paws::SNS::DeleteSMSSandboxPhoneNumber>
732  
733 Returns: a L<Paws::SNS::DeleteSMSSandboxPhoneNumberResult> instance
734  
735 Deletes an account's verified or pending phone number from the SMS
736 sandbox.
737  
738 When you start using Amazon SNS to send SMS messages, your account is
739 in the I<SMS sandbox>. The SMS sandbox provides a safe environment for
740 you to try Amazon SNS features without risking your reputation as an
741 SMS sender. While your account is in the SMS sandbox, you can use all
742 of the features of Amazon SNS. However, you can send SMS messages only
743 to verified destination phone numbers. For more information, including
744 how to move out of the sandbox to send messages without restrictions,
745 see SMS sandbox
746 (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the
747 I<Amazon SNS Developer Guide>.
748  
749  
750 =head2 DeleteTopic
751  
752 =over
753  
754 =item TopicArn => Str
755  
756  
757 =back
758  
759 Each argument is described in detail in: L<Paws::SNS::DeleteTopic>
760  
761 Returns: nothing
762  
763 Deletes a topic and all its subscriptions. Deleting a topic might
764 prevent some messages previously sent to the topic from being delivered
765 to subscribers. This action is idempotent, so deleting a topic that
766 does not exist does not result in an error.
767  
768  
769 =head2 GetEndpointAttributes
770  
771 =over
772  
773 =item EndpointArn => Str
774  
775  
776 =back
777  
778 Each argument is described in detail in: L<Paws::SNS::GetEndpointAttributes>
779  
780 Returns: a L<Paws::SNS::GetEndpointAttributesResponse> instance
781  
782 Retrieves the endpoint attributes for a device on one of the supported
783 push notification services, such as GCM (Firebase Cloud Messaging) and
784 APNS. For more information, see Using Amazon SNS Mobile Push
785 Notifications
786 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
787  
788  
789 =head2 GetPlatformApplicationAttributes
790  
791 =over
792  
793 =item PlatformApplicationArn => Str
794  
795  
796 =back
797  
798 Each argument is described in detail in: L<Paws::SNS::GetPlatformApplicationAttributes>
799  
800 Returns: a L<Paws::SNS::GetPlatformApplicationAttributesResponse> instance
801  
802 Retrieves the attributes of the platform application object for the
803 supported push notification services, such as APNS and GCM (Firebase
804 Cloud Messaging). For more information, see Using Amazon SNS Mobile
805 Push Notifications
806 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
807  
808  
809 =head2 GetSMSAttributes
810  
811 =over
812  
813 =item [Attributes => ArrayRef[Str|Undef]]
814  
815  
816 =back
817  
818 Each argument is described in detail in: L<Paws::SNS::GetSMSAttributes>
819  
820 Returns: a L<Paws::SNS::GetSMSAttributesResponse> instance
821  
822 Returns the settings for sending SMS messages from your account.
823  
824 These settings are set with the C<SetSMSAttributes> action.
825  
826  
827 =head2 GetSMSSandboxAccountStatus
828  
829  
830  
831  
832  
833  
834 Each argument is described in detail in: L<Paws::SNS::GetSMSSandboxAccountStatus>
835  
836 Returns: a L<Paws::SNS::GetSMSSandboxAccountStatusResult> instance
837  
838 Retrieves the SMS sandbox status for the calling account in the target
839 Region.
840  
841 When you start using Amazon SNS to send SMS messages, your account is
842 in the I<SMS sandbox>. The SMS sandbox provides a safe environment for
843 you to try Amazon SNS features without risking your reputation as an
844 SMS sender. While your account is in the SMS sandbox, you can use all
845 of the features of Amazon SNS. However, you can send SMS messages only
846 to verified destination phone numbers. For more information, including
847 how to move out of the sandbox to send messages without restrictions,
848 see SMS sandbox
849 (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the
850 I<Amazon SNS Developer Guide>.
851  
852  
853 =head2 GetSubscriptionAttributes
854  
855 =over
856  
857 =item SubscriptionArn => Str
858  
859  
860 =back
861  
862 Each argument is described in detail in: L<Paws::SNS::GetSubscriptionAttributes>
863  
864 Returns: a L<Paws::SNS::GetSubscriptionAttributesResponse> instance
865  
866 Returns all of the properties of a subscription.
867  
868  
869 =head2 GetTopicAttributes
870  
871 =over
872  
873 =item TopicArn => Str
874  
875  
876 =back
877  
878 Each argument is described in detail in: L<Paws::SNS::GetTopicAttributes>
879  
880 Returns: a L<Paws::SNS::GetTopicAttributesResponse> instance
881  
882 Returns all of the properties of a topic. Topic properties returned
883 might differ based on the authorization of the user.
884  
885  
886 =head2 ListEndpointsByPlatformApplication
887  
888 =over
889  
890 =item PlatformApplicationArn => Str
891  
892 =item [NextToken => Str]
893  
894  
895 =back
896  
897 Each argument is described in detail in: L<Paws::SNS::ListEndpointsByPlatformApplication>
898  
899 Returns: a L<Paws::SNS::ListEndpointsByPlatformApplicationResponse> instance
900  
901 Lists the endpoints and endpoint attributes for devices in a supported
902 push notification service, such as GCM (Firebase Cloud Messaging) and
903 APNS. The results for C<ListEndpointsByPlatformApplication> are
904 paginated and return a limited list of endpoints, up to 100. If
905 additional records are available after the first page results, then a
906 NextToken string will be returned. To receive the next page, you call
907 C<ListEndpointsByPlatformApplication> again using the NextToken string
908 received from the previous call. When there are no more records to
909 return, NextToken will be null. For more information, see Using Amazon
910 SNS Mobile Push Notifications
911 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
912  
913 This action is throttled at 30 transactions per second (TPS).
914  
915  
916 =head2 ListOriginationNumbers
917  
918 =over
919  
920 =item [MaxResults => Int]
921  
922 =item [NextToken => Str]
923  
924  
925 =back
926  
927 Each argument is described in detail in: L<Paws::SNS::ListOriginationNumbers>
928  
929 Returns: a L<Paws::SNS::ListOriginationNumbersResult> instance
930  
931 Lists the calling account's dedicated origination numbers and their
932 metadata. For more information about origination numbers, see
933 Origination numbers
934 (https://docs.aws.amazon.com/sns/latest/dg/channels-sms-originating-identities-origination-numbers.html)
935 in the I<Amazon SNS Developer Guide>.
936  
937  
938 =head2 ListPhoneNumbersOptedOut
939  
940 =over
941  
942 =item [NextToken => Str]
943  
944  
945 =back
946  
947 Each argument is described in detail in: L<Paws::SNS::ListPhoneNumbersOptedOut>
948  
949 Returns: a L<Paws::SNS::ListPhoneNumbersOptedOutResponse> instance
950  
951 Returns a list of phone numbers that are opted out, meaning you cannot
952 send SMS messages to them.
953  
954 The results for C<ListPhoneNumbersOptedOut> are paginated, and each
955 page returns up to 100 phone numbers. If additional phone numbers are
956 available after the first page of results, then a C<NextToken> string
957 will be returned. To receive the next page, you call
958 C<ListPhoneNumbersOptedOut> again using the C<NextToken> string
959 received from the previous call. When there are no more records to
960 return, C<NextToken> will be null.
961  
962  
963 =head2 ListPlatformApplications
964  
965 =over
966  
967 =item [NextToken => Str]
968  
969  
970 =back
971  
972 Each argument is described in detail in: L<Paws::SNS::ListPlatformApplications>
973  
974 Returns: a L<Paws::SNS::ListPlatformApplicationsResponse> instance
975  
976 Lists the platform application objects for the supported push
977 notification services, such as APNS and GCM (Firebase Cloud Messaging).
978 The results for C<ListPlatformApplications> are paginated and return a
979 limited list of applications, up to 100. If additional records are
980 available after the first page results, then a NextToken string will be
981 returned. To receive the next page, you call
982 C<ListPlatformApplications> using the NextToken string received from
983 the previous call. When there are no more records to return,
984 C<NextToken> will be null. For more information, see Using Amazon SNS
985 Mobile Push Notifications
986 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
987  
988 This action is throttled at 15 transactions per second (TPS).
989  
990  
991 =head2 ListSMSSandboxPhoneNumbers
992  
993 =over
994  
995 =item [MaxResults => Int]
996  
997 =item [NextToken => Str]
998  
999  
1000 =back
1001  
1002 Each argument is described in detail in: L<Paws::SNS::ListSMSSandboxPhoneNumbers>
1003  
1004 Returns: a L<Paws::SNS::ListSMSSandboxPhoneNumbersResult> instance
1005  
1006 Lists the calling account's current verified and pending destination
1007 phone numbers in the SMS sandbox.
1008  
1009 When you start using Amazon SNS to send SMS messages, your account is
1010 in the I<SMS sandbox>. The SMS sandbox provides a safe environment for
1011 you to try Amazon SNS features without risking your reputation as an
1012 SMS sender. While your account is in the SMS sandbox, you can use all
1013 of the features of Amazon SNS. However, you can send SMS messages only
1014 to verified destination phone numbers. For more information, including
1015 how to move out of the sandbox to send messages without restrictions,
1016 see SMS sandbox
1017 (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the
1018 I<Amazon SNS Developer Guide>.
1019  
1020  
1021 =head2 ListSubscriptions
1022  
1023 =over
1024  
1025 =item [NextToken => Str]
1026  
1027  
1028 =back
1029  
1030 Each argument is described in detail in: L<Paws::SNS::ListSubscriptions>
1031  
1032 Returns: a L<Paws::SNS::ListSubscriptionsResponse> instance
1033  
1034 Returns a list of the requester's subscriptions. Each call returns a
1035 limited list of subscriptions, up to 100. If there are more
1036 subscriptions, a C<NextToken> is also returned. Use the C<NextToken>
1037 parameter in a new C<ListSubscriptions> call to get further results.
1038  
1039 This action is throttled at 30 transactions per second (TPS).
1040  
1041  
1042 =head2 ListSubscriptionsByTopic
1043  
1044 =over
1045  
1046 =item TopicArn => Str
1047  
1048 =item [NextToken => Str]
1049  
1050  
1051 =back
1052  
1053 Each argument is described in detail in: L<Paws::SNS::ListSubscriptionsByTopic>
1054  
1055 Returns: a L<Paws::SNS::ListSubscriptionsByTopicResponse> instance
1056  
1057 Returns a list of the subscriptions to a specific topic. Each call
1058 returns a limited list of subscriptions, up to 100. If there are more
1059 subscriptions, a C<NextToken> is also returned. Use the C<NextToken>
1060 parameter in a new C<ListSubscriptionsByTopic> call to get further
1061 results.
1062  
1063 This action is throttled at 30 transactions per second (TPS).
1064  
1065  
1066 =head2 ListTagsForResource
1067  
1068 =over
1069  
1070 =item ResourceArn => Str
1071  
1072  
1073 =back
1074  
1075 Each argument is described in detail in: L<Paws::SNS::ListTagsForResource>
1076  
1077 Returns: a L<Paws::SNS::ListTagsForResourceResponse> instance
1078  
1079 List all tags added to the specified Amazon SNS topic. For an overview,
1080 see Amazon SNS Tags
1081 (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the
1082 I<Amazon Simple Notification Service Developer Guide>.
1083  
1084  
1085 =head2 ListTopics
1086  
1087 =over
1088  
1089 =item [NextToken => Str]
1090  
1091  
1092 =back
1093  
1094 Each argument is described in detail in: L<Paws::SNS::ListTopics>
1095  
1096 Returns: a L<Paws::SNS::ListTopicsResponse> instance
1097  
1098 Returns a list of the requester's topics. Each call returns a limited
1099 list of topics, up to 100. If there are more topics, a C<NextToken> is
1100 also returned. Use the C<NextToken> parameter in a new C<ListTopics>
1101 call to get further results.
1102  
1103 This action is throttled at 30 transactions per second (TPS).
1104  
1105  
1106 =head2 OptInPhoneNumber
1107  
1108 =over
1109  
1110 =item PhoneNumber => Str
1111  
1112  
1113 =back
1114  
1115 Each argument is described in detail in: L<Paws::SNS::OptInPhoneNumber>
1116  
1117 Returns: a L<Paws::SNS::OptInPhoneNumberResponse> instance
1118  
1119 Use this request to opt in a phone number that is opted out, which
1120 enables you to resume sending SMS messages to the number.
1121  
1122 You can opt in a phone number only once every 30 days.
1123  
1124  
1125 =head2 Publish
1126  
1127 =over
1128  
1129 =item Message => Str
1130  
1131 =item [MessageAttributes => L<Paws::SNS::MessageAttributeMap>]
1132  
1133 =item [MessageDeduplicationId => Str]
1134  
1135 =item [MessageGroupId => Str]
1136  
1137 =item [MessageStructure => Str]
1138  
1139 =item [PhoneNumber => Str]
1140  
1141 =item [Subject => Str]
1142  
1143 =item [TargetArn => Str]
1144  
1145 =item [TopicArn => Str]
1146  
1147  
1148 =back
1149  
1150 Each argument is described in detail in: L<Paws::SNS::Publish>
1151  
1152 Returns: a L<Paws::SNS::PublishResponse> instance
1153  
1154 Sends a message to an Amazon SNS topic, a text message (SMS message)
1155 directly to a phone number, or a message to a mobile platform endpoint
1156 (when you specify the C<TargetArn>).
1157  
1158 If you send a message to a topic, Amazon SNS delivers the message to
1159 each endpoint that is subscribed to the topic. The format of the
1160 message depends on the notification protocol for each subscribed
1161 endpoint.
1162  
1163 When a C<messageId> is returned, the message has been saved and Amazon
1164 SNS will attempt to deliver it shortly.
1165  
1166 To use the C<Publish> action for sending a message to a mobile
1167 endpoint, such as an app on a Kindle device or mobile phone, you must
1168 specify the EndpointArn for the TargetArn parameter. The EndpointArn is
1169 returned when making a call with the C<CreatePlatformEndpoint> action.
1170  
1171 For more information about formatting messages, see Send Custom
1172 Platform-Specific Payloads in Messages to Mobile Devices
1173 (https://docs.aws.amazon.com/sns/latest/dg/mobile-push-send-custommessage.html).
1174  
1175 You can publish messages only to topics and endpoints in the same
1176 Region.
1177  
1178  
1179 =head2 RemovePermission
1180  
1181 =over
1182  
1183 =item Label => Str
1184  
1185 =item TopicArn => Str
1186  
1187  
1188 =back
1189  
1190 Each argument is described in detail in: L<Paws::SNS::RemovePermission>
1191  
1192 Returns: nothing
1193  
1194 Removes a statement from a topic's access control policy.
1195  
1196  
1197 =head2 SetEndpointAttributes
1198  
1199 =over
1200  
1201 =item Attributes => L<Paws::SNS::MapStringToString>
1202  
1203 =item EndpointArn => Str
1204  
1205  
1206 =back
1207  
1208 Each argument is described in detail in: L<Paws::SNS::SetEndpointAttributes>
1209  
1210 Returns: nothing
1211  
1212 Sets the attributes for an endpoint for a device on one of the
1213 supported push notification services, such as GCM (Firebase Cloud
1214 Messaging) and APNS. For more information, see Using Amazon SNS Mobile
1215 Push Notifications
1216 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html).
1217  
1218  
1219 =head2 SetPlatformApplicationAttributes
1220  
1221 =over
1222  
1223 =item Attributes => L<Paws::SNS::MapStringToString>
1224  
1225 =item PlatformApplicationArn => Str
1226  
1227  
1228 =back
1229  
1230 Each argument is described in detail in: L<Paws::SNS::SetPlatformApplicationAttributes>
1231  
1232 Returns: nothing
1233  
1234 Sets the attributes of the platform application object for the
1235 supported push notification services, such as APNS and GCM (Firebase
1236 Cloud Messaging). For more information, see Using Amazon SNS Mobile
1237 Push Notifications
1238 (https://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html). For
1239 information on configuring attributes for message delivery status, see
1240 Using Amazon SNS Application Attributes for Message Delivery Status
1241 (https://docs.aws.amazon.com/sns/latest/dg/sns-msg-status.html).
1242  
1243  
1244 =head2 SetSMSAttributes
1245  
1246 =over
1247  
1248 =item Attributes => L<Paws::SNS::MapStringToString>
1249  
1250  
1251 =back
1252  
1253 Each argument is described in detail in: L<Paws::SNS::SetSMSAttributes>
1254  
1255 Returns: a L<Paws::SNS::SetSMSAttributesResponse> instance
1256  
1257 Use this request to set the default settings for sending SMS messages
1258 and receiving daily SMS usage reports.
1259  
1260 You can override some of these settings for a single message when you
1261 use the C<Publish> action with the C<MessageAttributes.entry.N>
1262 parameter. For more information, see Publishing to a mobile phone
1263 (https://docs.aws.amazon.com/sns/latest/dg/sms_publish-to-phone.html)
1264 in the I<Amazon SNS Developer Guide>.
1265  
1266 To use this operation, you must grant the Amazon SNS service principal
1267 (C<sns.amazonaws.com>) permission to perform the C<s3:ListBucket>
1268 action.
1269  
1270  
1271 =head2 SetSubscriptionAttributes
1272  
1273 =over
1274  
1275 =item AttributeName => Str
1276  
1277 =item SubscriptionArn => Str
1278  
1279 =item [AttributeValue => Str]
1280  
1281  
1282 =back
1283  
1284 Each argument is described in detail in: L<Paws::SNS::SetSubscriptionAttributes>
1285  
1286 Returns: nothing
1287  
1288 Allows a subscription owner to set an attribute of the subscription to
1289 a new value.
1290  
1291  
1292 =head2 SetTopicAttributes
1293  
1294 =over
1295  
1296 =item AttributeName => Str
1297  
1298 =item TopicArn => Str
1299  
1300 =item [AttributeValue => Str]
1301  
1302  
1303 =back
1304  
1305 Each argument is described in detail in: L<Paws::SNS::SetTopicAttributes>
1306  
1307 Returns: nothing
1308  
1309 Allows a topic owner to set an attribute of the topic to a new value.
1310  
1311  
1312 =head2 Subscribe
1313  
1314 =over
1315  
1316 =item Protocol => Str
1317  
1318 =item TopicArn => Str
1319  
1320 =item [Attributes => L<Paws::SNS::SubscriptionAttributesMap>]
1321  
1322 =item [Endpoint => Str]
1323  
1324 =item [ReturnSubscriptionArn => Bool]
1325  
1326  
1327 =back
1328  
1329 Each argument is described in detail in: L<Paws::SNS::Subscribe>
1330  
1331 Returns: a L<Paws::SNS::SubscribeResponse> instance
1332  
1333 Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is
1334 HTTP/S or email, or if the endpoint and the topic are not in the same
1335 account, the endpoint owner must run the C<ConfirmSubscription> action
1336 to confirm the subscription.
1337  
1338 You call the C<ConfirmSubscription> action with the token from the
1339 subscription response. Confirmation tokens are valid for three days.
1340  
1341 This action is throttled at 100 transactions per second (TPS).
1342  
1343  
1344 =head2 TagResource
1345  
1346 =over
1347  
1348 =item ResourceArn => Str
1349  
1350 =item Tags => ArrayRef[L<Paws::SNS::Tag>]
1351  
1352  
1353 =back
1354  
1355 Each argument is described in detail in: L<Paws::SNS::TagResource>
1356  
1357 Returns: a L<Paws::SNS::TagResourceResponse> instance
1358  
1359 Add tags to the specified Amazon SNS topic. For an overview, see Amazon
1360 SNS Tags (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in
1361 the I<Amazon SNS Developer Guide>.
1362  
1363 When you use topic tags, keep the following guidelines in mind:
1364  
1365 =over
1366  
1367 =item *
1368  
1369 Adding more than 50 tags to a topic isn't recommended.
1370  
1371 =item *
1372  
1373 Tags don't have any semantic meaning. Amazon SNS interprets tags as
1374 character strings.
1375  
1376 =item *
1377  
1378 Tags are case-sensitive.
1379  
1380 =item *
1381  
1382 A new tag with a key identical to that of an existing tag overwrites
1383 the existing tag.
1384  
1385 =item *
1386  
1387 Tagging actions are limited to 10 TPS per account, per Region. If your
1388 application requires a higher throughput, file a technical support
1389 request
1390 (https://console.aws.amazon.com/support/home#/case/create?issueType=technical).
1391  
1392 =back
1393  
1394  
1395  
1396 =head2 Unsubscribe
1397  
1398 =over
1399  
1400 =item SubscriptionArn => Str
1401  
1402  
1403 =back
1404  
1405 Each argument is described in detail in: L<Paws::SNS::Unsubscribe>
1406  
1407 Returns: nothing
1408  
1409 Deletes a subscription. If the subscription requires authentication for
1410 deletion, only the owner of the subscription or the topic's owner can
1411 unsubscribe, and an Amazon Web Services signature is required. If the
1412 C<Unsubscribe> call does not require authentication and the requester
1413 is not the subscription owner, a final cancellation message is
1414 delivered to the endpoint, so that the endpoint owner can easily
1415 resubscribe to the topic if the C<Unsubscribe> request was unintended.
1416  
1417 This action is throttled at 100 transactions per second (TPS).
1418  
1419  
1420 =head2 UntagResource
1421  
1422 =over
1423  
1424 =item ResourceArn => Str
1425  
1426 =item TagKeys => ArrayRef[Str|Undef]
1427  
1428  
1429 =back
1430  
1431 Each argument is described in detail in: L<Paws::SNS::UntagResource>
1432  
1433 Returns: a L<Paws::SNS::UntagResourceResponse> instance
1434  
1435 Remove tags from the specified Amazon SNS topic. For an overview, see
1436 Amazon SNS Tags
1437 (https://docs.aws.amazon.com/sns/latest/dg/sns-tags.html) in the
1438 I<Amazon SNS Developer Guide>.
1439  
1440  
1441 =head2 VerifySMSSandboxPhoneNumber
1442  
1443 =over
1444  
1445 =item OneTimePassword => Str
1446  
1447 =item PhoneNumber => Str
1448  
1449  
1450 =back
1451  
1452 Each argument is described in detail in: L<Paws::SNS::VerifySMSSandboxPhoneNumber>
1453  
1454 Returns: a L<Paws::SNS::VerifySMSSandboxPhoneNumberResult> instance
1455  
1456 Verifies a destination phone number with a one-time password (OTP) for
1457 the calling account.
1458  
1459 When you start using Amazon SNS to send SMS messages, your account is
1460 in the I<SMS sandbox>. The SMS sandbox provides a safe environment for
1461 you to try Amazon SNS features without risking your reputation as an
1462 SMS sender. While your account is in the SMS sandbox, you can use all
1463 of the features of Amazon SNS. However, you can send SMS messages only
1464 to verified destination phone numbers. For more information, including
1465 how to move out of the sandbox to send messages without restrictions,
1466 see SMS sandbox
1467 (https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html) in the
1468 I<Amazon SNS Developer Guide>.
1469  
1470  
1471  
1472  
1473 =head1 PAGINATORS
1474  
1475 Paginator methods are helpers that repetively call methods that return partial results
1476  
1477 =head2 ListAllEndpointsByPlatformApplication(sub { },PlatformApplicationArn => Str, [NextToken => Str])
1478  
1479 =head2 ListAllEndpointsByPlatformApplication(PlatformApplicationArn => Str, [NextToken => Str])
1480  
1481  
1482 If passed a sub as first parameter, it will call the sub for each element found in :
1483  
1484 - Endpoints, passing the object as the first parameter, and the string 'Endpoints' as the second parameter
1485  
1486 If not, it will return a a L<Paws::SNS::ListEndpointsByPlatformApplicationResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1487  
1488  
1489 =head2 ListAllOriginationNumbers(sub { },[MaxResults => Int, NextToken => Str])
1490  
1491 =head2 ListAllOriginationNumbers([MaxResults => Int, NextToken => Str])
1492  
1493  
1494 If passed a sub as first parameter, it will call the sub for each element found in :
1495  
1496 - PhoneNumbers, passing the object as the first parameter, and the string 'PhoneNumbers' as the second parameter
1497  
1498 If not, it will return a a L<Paws::SNS::ListOriginationNumbersResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1499  
1500  
1501 =head2 ListAllPhoneNumbersOptedOut(sub { },[NextToken => Str])
1502  
1503 =head2 ListAllPhoneNumbersOptedOut([NextToken => Str])
1504  
1505  
1506 If passed a sub as first parameter, it will call the sub for each element found in :
1507  
1508 - phoneNumbers, passing the object as the first parameter, and the string 'phoneNumbers' as the second parameter
1509  
1510 If not, it will return a a L<Paws::SNS::ListPhoneNumbersOptedOutResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1511  
1512  
1513 =head2 ListAllPlatformApplications(sub { },[NextToken => Str])
1514  
1515 =head2 ListAllPlatformApplications([NextToken => Str])
1516  
1517  
1518 If passed a sub as first parameter, it will call the sub for each element found in :
1519  
1520 - PlatformApplications, passing the object as the first parameter, and the string 'PlatformApplications' as the second parameter
1521  
1522 If not, it will return a a L<Paws::SNS::ListPlatformApplicationsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1523  
1524  
1525 =head2 ListAllSMSSandboxPhoneNumbers(sub { },[MaxResults => Int, NextToken => Str])
1526  
1527 =head2 ListAllSMSSandboxPhoneNumbers([MaxResults => Int, NextToken => Str])
1528  
1529  
1530 If passed a sub as first parameter, it will call the sub for each element found in :
1531  
1532 - PhoneNumbers, passing the object as the first parameter, and the string 'PhoneNumbers' as the second parameter
1533  
1534 If not, it will return a a L<Paws::SNS::ListSMSSandboxPhoneNumbersResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1535  
1536  
1537 =head2 ListAllSubscriptions(sub { },[NextToken => Str])
1538  
1539 =head2 ListAllSubscriptions([NextToken => Str])
1540  
1541  
1542 If passed a sub as first parameter, it will call the sub for each element found in :
1543  
1544 - Subscriptions, passing the object as the first parameter, and the string 'Subscriptions' as the second parameter
1545  
1546 If not, it will return a a L<Paws::SNS::ListSubscriptionsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1547  
1548  
1549 =head2 ListAllSubscriptionsByTopic(sub { },TopicArn => Str, [NextToken => Str])
1550  
1551 =head2 ListAllSubscriptionsByTopic(TopicArn => Str, [NextToken => Str])
1552  
1553  
1554 If passed a sub as first parameter, it will call the sub for each element found in :
1555  
1556 - Subscriptions, passing the object as the first parameter, and the string 'Subscriptions' as the second parameter
1557  
1558 If not, it will return a a L<Paws::SNS::ListSubscriptionsByTopicResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1559  
1560  
1561 =head2 ListAllTopics(sub { },[NextToken => Str])
1562  
1563 =head2 ListAllTopics([NextToken => Str])
1564  
1565  
1566 If passed a sub as first parameter, it will call the sub for each element found in :
1567  
1568 - Topics, passing the object as the first parameter, and the string 'Topics' as the second parameter
1569  
1570 If not, it will return a a L<Paws::SNS::ListTopicsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
1571  
1572  
1573  
1574  
1575  
1576 =head1 SEE ALSO
1577  
1578 This service class forms part of L<Paws>
1579  
1580 =head1 BUGS and CONTRIBUTIONS
1581  
1582 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
1583  
1584 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
1585  
1586 =cut
1587  
« blib/lib/Paws/Polly.pm ↑ Summary lib/Paws/ElasticTranscoder.pm »