UNPKG

15.1 kBJSONView Raw
1{
2 "version": "2.0",
3 "metadata": {
4 "apiVersion": "2010-03-31",
5 "endpointPrefix": "sns",
6 "protocol": "query",
7 "serviceAbbreviation": "Amazon SNS",
8 "serviceFullName": "Amazon Simple Notification Service",
9 "serviceId": "SNS",
10 "signatureVersion": "v4",
11 "uid": "sns-2010-03-31",
12 "xmlNamespace": "http://sns.amazonaws.com/doc/2010-03-31/"
13 },
14 "operations": {
15 "AddPermission": {
16 "input": {
17 "type": "structure",
18 "required": [
19 "TopicArn",
20 "Label",
21 "AWSAccountId",
22 "ActionName"
23 ],
24 "members": {
25 "TopicArn": {},
26 "Label": {},
27 "AWSAccountId": {
28 "type": "list",
29 "member": {}
30 },
31 "ActionName": {
32 "type": "list",
33 "member": {}
34 }
35 }
36 }
37 },
38 "CheckIfPhoneNumberIsOptedOut": {
39 "input": {
40 "type": "structure",
41 "required": [
42 "phoneNumber"
43 ],
44 "members": {
45 "phoneNumber": {}
46 }
47 },
48 "output": {
49 "resultWrapper": "CheckIfPhoneNumberIsOptedOutResult",
50 "type": "structure",
51 "members": {
52 "isOptedOut": {
53 "type": "boolean"
54 }
55 }
56 }
57 },
58 "ConfirmSubscription": {
59 "input": {
60 "type": "structure",
61 "required": [
62 "TopicArn",
63 "Token"
64 ],
65 "members": {
66 "TopicArn": {},
67 "Token": {},
68 "AuthenticateOnUnsubscribe": {}
69 }
70 },
71 "output": {
72 "resultWrapper": "ConfirmSubscriptionResult",
73 "type": "structure",
74 "members": {
75 "SubscriptionArn": {}
76 }
77 }
78 },
79 "CreatePlatformApplication": {
80 "input": {
81 "type": "structure",
82 "required": [
83 "Name",
84 "Platform",
85 "Attributes"
86 ],
87 "members": {
88 "Name": {},
89 "Platform": {},
90 "Attributes": {
91 "shape": "Sj"
92 }
93 }
94 },
95 "output": {
96 "resultWrapper": "CreatePlatformApplicationResult",
97 "type": "structure",
98 "members": {
99 "PlatformApplicationArn": {}
100 }
101 }
102 },
103 "CreatePlatformEndpoint": {
104 "input": {
105 "type": "structure",
106 "required": [
107 "PlatformApplicationArn",
108 "Token"
109 ],
110 "members": {
111 "PlatformApplicationArn": {},
112 "Token": {},
113 "CustomUserData": {},
114 "Attributes": {
115 "shape": "Sj"
116 }
117 }
118 },
119 "output": {
120 "resultWrapper": "CreatePlatformEndpointResult",
121 "type": "structure",
122 "members": {
123 "EndpointArn": {}
124 }
125 }
126 },
127 "CreateTopic": {
128 "input": {
129 "type": "structure",
130 "required": [
131 "Name"
132 ],
133 "members": {
134 "Name": {},
135 "Attributes": {
136 "shape": "Sp"
137 },
138 "Tags": {
139 "shape": "Ss"
140 }
141 }
142 },
143 "output": {
144 "resultWrapper": "CreateTopicResult",
145 "type": "structure",
146 "members": {
147 "TopicArn": {}
148 }
149 }
150 },
151 "DeleteEndpoint": {
152 "input": {
153 "type": "structure",
154 "required": [
155 "EndpointArn"
156 ],
157 "members": {
158 "EndpointArn": {}
159 }
160 }
161 },
162 "DeletePlatformApplication": {
163 "input": {
164 "type": "structure",
165 "required": [
166 "PlatformApplicationArn"
167 ],
168 "members": {
169 "PlatformApplicationArn": {}
170 }
171 }
172 },
173 "DeleteTopic": {
174 "input": {
175 "type": "structure",
176 "required": [
177 "TopicArn"
178 ],
179 "members": {
180 "TopicArn": {}
181 }
182 }
183 },
184 "GetEndpointAttributes": {
185 "input": {
186 "type": "structure",
187 "required": [
188 "EndpointArn"
189 ],
190 "members": {
191 "EndpointArn": {}
192 }
193 },
194 "output": {
195 "resultWrapper": "GetEndpointAttributesResult",
196 "type": "structure",
197 "members": {
198 "Attributes": {
199 "shape": "Sj"
200 }
201 }
202 }
203 },
204 "GetPlatformApplicationAttributes": {
205 "input": {
206 "type": "structure",
207 "required": [
208 "PlatformApplicationArn"
209 ],
210 "members": {
211 "PlatformApplicationArn": {}
212 }
213 },
214 "output": {
215 "resultWrapper": "GetPlatformApplicationAttributesResult",
216 "type": "structure",
217 "members": {
218 "Attributes": {
219 "shape": "Sj"
220 }
221 }
222 }
223 },
224 "GetSMSAttributes": {
225 "input": {
226 "type": "structure",
227 "members": {
228 "attributes": {
229 "type": "list",
230 "member": {}
231 }
232 }
233 },
234 "output": {
235 "resultWrapper": "GetSMSAttributesResult",
236 "type": "structure",
237 "members": {
238 "attributes": {
239 "shape": "Sj"
240 }
241 }
242 }
243 },
244 "GetSubscriptionAttributes": {
245 "input": {
246 "type": "structure",
247 "required": [
248 "SubscriptionArn"
249 ],
250 "members": {
251 "SubscriptionArn": {}
252 }
253 },
254 "output": {
255 "resultWrapper": "GetSubscriptionAttributesResult",
256 "type": "structure",
257 "members": {
258 "Attributes": {
259 "shape": "S19"
260 }
261 }
262 }
263 },
264 "GetTopicAttributes": {
265 "input": {
266 "type": "structure",
267 "required": [
268 "TopicArn"
269 ],
270 "members": {
271 "TopicArn": {}
272 }
273 },
274 "output": {
275 "resultWrapper": "GetTopicAttributesResult",
276 "type": "structure",
277 "members": {
278 "Attributes": {
279 "shape": "Sp"
280 }
281 }
282 }
283 },
284 "ListEndpointsByPlatformApplication": {
285 "input": {
286 "type": "structure",
287 "required": [
288 "PlatformApplicationArn"
289 ],
290 "members": {
291 "PlatformApplicationArn": {},
292 "NextToken": {}
293 }
294 },
295 "output": {
296 "resultWrapper": "ListEndpointsByPlatformApplicationResult",
297 "type": "structure",
298 "members": {
299 "Endpoints": {
300 "type": "list",
301 "member": {
302 "type": "structure",
303 "members": {
304 "EndpointArn": {},
305 "Attributes": {
306 "shape": "Sj"
307 }
308 }
309 }
310 },
311 "NextToken": {}
312 }
313 }
314 },
315 "ListPhoneNumbersOptedOut": {
316 "input": {
317 "type": "structure",
318 "members": {
319 "nextToken": {}
320 }
321 },
322 "output": {
323 "resultWrapper": "ListPhoneNumbersOptedOutResult",
324 "type": "structure",
325 "members": {
326 "phoneNumbers": {
327 "type": "list",
328 "member": {}
329 },
330 "nextToken": {}
331 }
332 }
333 },
334 "ListPlatformApplications": {
335 "input": {
336 "type": "structure",
337 "members": {
338 "NextToken": {}
339 }
340 },
341 "output": {
342 "resultWrapper": "ListPlatformApplicationsResult",
343 "type": "structure",
344 "members": {
345 "PlatformApplications": {
346 "type": "list",
347 "member": {
348 "type": "structure",
349 "members": {
350 "PlatformApplicationArn": {},
351 "Attributes": {
352 "shape": "Sj"
353 }
354 }
355 }
356 },
357 "NextToken": {}
358 }
359 }
360 },
361 "ListSubscriptions": {
362 "input": {
363 "type": "structure",
364 "members": {
365 "NextToken": {}
366 }
367 },
368 "output": {
369 "resultWrapper": "ListSubscriptionsResult",
370 "type": "structure",
371 "members": {
372 "Subscriptions": {
373 "shape": "S1r"
374 },
375 "NextToken": {}
376 }
377 }
378 },
379 "ListSubscriptionsByTopic": {
380 "input": {
381 "type": "structure",
382 "required": [
383 "TopicArn"
384 ],
385 "members": {
386 "TopicArn": {},
387 "NextToken": {}
388 }
389 },
390 "output": {
391 "resultWrapper": "ListSubscriptionsByTopicResult",
392 "type": "structure",
393 "members": {
394 "Subscriptions": {
395 "shape": "S1r"
396 },
397 "NextToken": {}
398 }
399 }
400 },
401 "ListTagsForResource": {
402 "input": {
403 "type": "structure",
404 "required": [
405 "ResourceArn"
406 ],
407 "members": {
408 "ResourceArn": {}
409 }
410 },
411 "output": {
412 "resultWrapper": "ListTagsForResourceResult",
413 "type": "structure",
414 "members": {
415 "Tags": {
416 "shape": "Ss"
417 }
418 }
419 }
420 },
421 "ListTopics": {
422 "input": {
423 "type": "structure",
424 "members": {
425 "NextToken": {}
426 }
427 },
428 "output": {
429 "resultWrapper": "ListTopicsResult",
430 "type": "structure",
431 "members": {
432 "Topics": {
433 "type": "list",
434 "member": {
435 "type": "structure",
436 "members": {
437 "TopicArn": {}
438 }
439 }
440 },
441 "NextToken": {}
442 }
443 }
444 },
445 "OptInPhoneNumber": {
446 "input": {
447 "type": "structure",
448 "required": [
449 "phoneNumber"
450 ],
451 "members": {
452 "phoneNumber": {}
453 }
454 },
455 "output": {
456 "resultWrapper": "OptInPhoneNumberResult",
457 "type": "structure",
458 "members": {}
459 }
460 },
461 "Publish": {
462 "input": {
463 "type": "structure",
464 "required": [
465 "Message"
466 ],
467 "members": {
468 "TopicArn": {},
469 "TargetArn": {},
470 "PhoneNumber": {},
471 "Message": {},
472 "Subject": {},
473 "MessageStructure": {},
474 "MessageAttributes": {
475 "type": "map",
476 "key": {
477 "locationName": "Name"
478 },
479 "value": {
480 "locationName": "Value",
481 "type": "structure",
482 "required": [
483 "DataType"
484 ],
485 "members": {
486 "DataType": {},
487 "StringValue": {},
488 "BinaryValue": {
489 "type": "blob"
490 }
491 }
492 }
493 }
494 }
495 },
496 "output": {
497 "resultWrapper": "PublishResult",
498 "type": "structure",
499 "members": {
500 "MessageId": {}
501 }
502 }
503 },
504 "RemovePermission": {
505 "input": {
506 "type": "structure",
507 "required": [
508 "TopicArn",
509 "Label"
510 ],
511 "members": {
512 "TopicArn": {},
513 "Label": {}
514 }
515 }
516 },
517 "SetEndpointAttributes": {
518 "input": {
519 "type": "structure",
520 "required": [
521 "EndpointArn",
522 "Attributes"
523 ],
524 "members": {
525 "EndpointArn": {},
526 "Attributes": {
527 "shape": "Sj"
528 }
529 }
530 }
531 },
532 "SetPlatformApplicationAttributes": {
533 "input": {
534 "type": "structure",
535 "required": [
536 "PlatformApplicationArn",
537 "Attributes"
538 ],
539 "members": {
540 "PlatformApplicationArn": {},
541 "Attributes": {
542 "shape": "Sj"
543 }
544 }
545 }
546 },
547 "SetSMSAttributes": {
548 "input": {
549 "type": "structure",
550 "required": [
551 "attributes"
552 ],
553 "members": {
554 "attributes": {
555 "shape": "Sj"
556 }
557 }
558 },
559 "output": {
560 "resultWrapper": "SetSMSAttributesResult",
561 "type": "structure",
562 "members": {}
563 }
564 },
565 "SetSubscriptionAttributes": {
566 "input": {
567 "type": "structure",
568 "required": [
569 "SubscriptionArn",
570 "AttributeName"
571 ],
572 "members": {
573 "SubscriptionArn": {},
574 "AttributeName": {},
575 "AttributeValue": {}
576 }
577 }
578 },
579 "SetTopicAttributes": {
580 "input": {
581 "type": "structure",
582 "required": [
583 "TopicArn",
584 "AttributeName"
585 ],
586 "members": {
587 "TopicArn": {},
588 "AttributeName": {},
589 "AttributeValue": {}
590 }
591 }
592 },
593 "Subscribe": {
594 "input": {
595 "type": "structure",
596 "required": [
597 "TopicArn",
598 "Protocol"
599 ],
600 "members": {
601 "TopicArn": {},
602 "Protocol": {},
603 "Endpoint": {},
604 "Attributes": {
605 "shape": "S19"
606 },
607 "ReturnSubscriptionArn": {
608 "type": "boolean"
609 }
610 }
611 },
612 "output": {
613 "resultWrapper": "SubscribeResult",
614 "type": "structure",
615 "members": {
616 "SubscriptionArn": {}
617 }
618 }
619 },
620 "TagResource": {
621 "input": {
622 "type": "structure",
623 "required": [
624 "ResourceArn",
625 "Tags"
626 ],
627 "members": {
628 "ResourceArn": {},
629 "Tags": {
630 "shape": "Ss"
631 }
632 }
633 },
634 "output": {
635 "resultWrapper": "TagResourceResult",
636 "type": "structure",
637 "members": {}
638 }
639 },
640 "Unsubscribe": {
641 "input": {
642 "type": "structure",
643 "required": [
644 "SubscriptionArn"
645 ],
646 "members": {
647 "SubscriptionArn": {}
648 }
649 }
650 },
651 "UntagResource": {
652 "input": {
653 "type": "structure",
654 "required": [
655 "ResourceArn",
656 "TagKeys"
657 ],
658 "members": {
659 "ResourceArn": {},
660 "TagKeys": {
661 "type": "list",
662 "member": {}
663 }
664 }
665 },
666 "output": {
667 "resultWrapper": "UntagResourceResult",
668 "type": "structure",
669 "members": {}
670 }
671 }
672 },
673 "shapes": {
674 "Sj": {
675 "type": "map",
676 "key": {},
677 "value": {}
678 },
679 "Sp": {
680 "type": "map",
681 "key": {},
682 "value": {}
683 },
684 "Ss": {
685 "type": "list",
686 "member": {
687 "type": "structure",
688 "required": [
689 "Key",
690 "Value"
691 ],
692 "members": {
693 "Key": {},
694 "Value": {}
695 }
696 }
697 },
698 "S19": {
699 "type": "map",
700 "key": {},
701 "value": {}
702 },
703 "S1r": {
704 "type": "list",
705 "member": {
706 "type": "structure",
707 "members": {
708 "SubscriptionArn": {},
709 "Owner": {},
710 "Protocol": {},
711 "Endpoint": {},
712 "TopicArn": {}
713 }
714 }
715 }
716 }
717}
\No newline at end of file