UNPKG

13.6 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 }
139 },
140 "output": {
141 "resultWrapper": "CreateTopicResult",
142 "type": "structure",
143 "members": {
144 "TopicArn": {}
145 }
146 }
147 },
148 "DeleteEndpoint": {
149 "input": {
150 "type": "structure",
151 "required": [
152 "EndpointArn"
153 ],
154 "members": {
155 "EndpointArn": {}
156 }
157 }
158 },
159 "DeletePlatformApplication": {
160 "input": {
161 "type": "structure",
162 "required": [
163 "PlatformApplicationArn"
164 ],
165 "members": {
166 "PlatformApplicationArn": {}
167 }
168 }
169 },
170 "DeleteTopic": {
171 "input": {
172 "type": "structure",
173 "required": [
174 "TopicArn"
175 ],
176 "members": {
177 "TopicArn": {}
178 }
179 }
180 },
181 "GetEndpointAttributes": {
182 "input": {
183 "type": "structure",
184 "required": [
185 "EndpointArn"
186 ],
187 "members": {
188 "EndpointArn": {}
189 }
190 },
191 "output": {
192 "resultWrapper": "GetEndpointAttributesResult",
193 "type": "structure",
194 "members": {
195 "Attributes": {
196 "shape": "Sj"
197 }
198 }
199 }
200 },
201 "GetPlatformApplicationAttributes": {
202 "input": {
203 "type": "structure",
204 "required": [
205 "PlatformApplicationArn"
206 ],
207 "members": {
208 "PlatformApplicationArn": {}
209 }
210 },
211 "output": {
212 "resultWrapper": "GetPlatformApplicationAttributesResult",
213 "type": "structure",
214 "members": {
215 "Attributes": {
216 "shape": "Sj"
217 }
218 }
219 }
220 },
221 "GetSMSAttributes": {
222 "input": {
223 "type": "structure",
224 "members": {
225 "attributes": {
226 "type": "list",
227 "member": {}
228 }
229 }
230 },
231 "output": {
232 "resultWrapper": "GetSMSAttributesResult",
233 "type": "structure",
234 "members": {
235 "attributes": {
236 "shape": "Sj"
237 }
238 }
239 }
240 },
241 "GetSubscriptionAttributes": {
242 "input": {
243 "type": "structure",
244 "required": [
245 "SubscriptionArn"
246 ],
247 "members": {
248 "SubscriptionArn": {}
249 }
250 },
251 "output": {
252 "resultWrapper": "GetSubscriptionAttributesResult",
253 "type": "structure",
254 "members": {
255 "Attributes": {
256 "shape": "S15"
257 }
258 }
259 }
260 },
261 "GetTopicAttributes": {
262 "input": {
263 "type": "structure",
264 "required": [
265 "TopicArn"
266 ],
267 "members": {
268 "TopicArn": {}
269 }
270 },
271 "output": {
272 "resultWrapper": "GetTopicAttributesResult",
273 "type": "structure",
274 "members": {
275 "Attributes": {
276 "shape": "Sp"
277 }
278 }
279 }
280 },
281 "ListEndpointsByPlatformApplication": {
282 "input": {
283 "type": "structure",
284 "required": [
285 "PlatformApplicationArn"
286 ],
287 "members": {
288 "PlatformApplicationArn": {},
289 "NextToken": {}
290 }
291 },
292 "output": {
293 "resultWrapper": "ListEndpointsByPlatformApplicationResult",
294 "type": "structure",
295 "members": {
296 "Endpoints": {
297 "type": "list",
298 "member": {
299 "type": "structure",
300 "members": {
301 "EndpointArn": {},
302 "Attributes": {
303 "shape": "Sj"
304 }
305 }
306 }
307 },
308 "NextToken": {}
309 }
310 }
311 },
312 "ListPhoneNumbersOptedOut": {
313 "input": {
314 "type": "structure",
315 "members": {
316 "nextToken": {}
317 }
318 },
319 "output": {
320 "resultWrapper": "ListPhoneNumbersOptedOutResult",
321 "type": "structure",
322 "members": {
323 "phoneNumbers": {
324 "type": "list",
325 "member": {}
326 },
327 "nextToken": {}
328 }
329 }
330 },
331 "ListPlatformApplications": {
332 "input": {
333 "type": "structure",
334 "members": {
335 "NextToken": {}
336 }
337 },
338 "output": {
339 "resultWrapper": "ListPlatformApplicationsResult",
340 "type": "structure",
341 "members": {
342 "PlatformApplications": {
343 "type": "list",
344 "member": {
345 "type": "structure",
346 "members": {
347 "PlatformApplicationArn": {},
348 "Attributes": {
349 "shape": "Sj"
350 }
351 }
352 }
353 },
354 "NextToken": {}
355 }
356 }
357 },
358 "ListSubscriptions": {
359 "input": {
360 "type": "structure",
361 "members": {
362 "NextToken": {}
363 }
364 },
365 "output": {
366 "resultWrapper": "ListSubscriptionsResult",
367 "type": "structure",
368 "members": {
369 "Subscriptions": {
370 "shape": "S1n"
371 },
372 "NextToken": {}
373 }
374 }
375 },
376 "ListSubscriptionsByTopic": {
377 "input": {
378 "type": "structure",
379 "required": [
380 "TopicArn"
381 ],
382 "members": {
383 "TopicArn": {},
384 "NextToken": {}
385 }
386 },
387 "output": {
388 "resultWrapper": "ListSubscriptionsByTopicResult",
389 "type": "structure",
390 "members": {
391 "Subscriptions": {
392 "shape": "S1n"
393 },
394 "NextToken": {}
395 }
396 }
397 },
398 "ListTopics": {
399 "input": {
400 "type": "structure",
401 "members": {
402 "NextToken": {}
403 }
404 },
405 "output": {
406 "resultWrapper": "ListTopicsResult",
407 "type": "structure",
408 "members": {
409 "Topics": {
410 "type": "list",
411 "member": {
412 "type": "structure",
413 "members": {
414 "TopicArn": {}
415 }
416 }
417 },
418 "NextToken": {}
419 }
420 }
421 },
422 "OptInPhoneNumber": {
423 "input": {
424 "type": "structure",
425 "required": [
426 "phoneNumber"
427 ],
428 "members": {
429 "phoneNumber": {}
430 }
431 },
432 "output": {
433 "resultWrapper": "OptInPhoneNumberResult",
434 "type": "structure",
435 "members": {}
436 }
437 },
438 "Publish": {
439 "input": {
440 "type": "structure",
441 "required": [
442 "Message"
443 ],
444 "members": {
445 "TopicArn": {},
446 "TargetArn": {},
447 "PhoneNumber": {},
448 "Message": {},
449 "Subject": {},
450 "MessageStructure": {},
451 "MessageAttributes": {
452 "type": "map",
453 "key": {
454 "locationName": "Name"
455 },
456 "value": {
457 "locationName": "Value",
458 "type": "structure",
459 "required": [
460 "DataType"
461 ],
462 "members": {
463 "DataType": {},
464 "StringValue": {},
465 "BinaryValue": {
466 "type": "blob"
467 }
468 }
469 }
470 }
471 }
472 },
473 "output": {
474 "resultWrapper": "PublishResult",
475 "type": "structure",
476 "members": {
477 "MessageId": {}
478 }
479 }
480 },
481 "RemovePermission": {
482 "input": {
483 "type": "structure",
484 "required": [
485 "TopicArn",
486 "Label"
487 ],
488 "members": {
489 "TopicArn": {},
490 "Label": {}
491 }
492 }
493 },
494 "SetEndpointAttributes": {
495 "input": {
496 "type": "structure",
497 "required": [
498 "EndpointArn",
499 "Attributes"
500 ],
501 "members": {
502 "EndpointArn": {},
503 "Attributes": {
504 "shape": "Sj"
505 }
506 }
507 }
508 },
509 "SetPlatformApplicationAttributes": {
510 "input": {
511 "type": "structure",
512 "required": [
513 "PlatformApplicationArn",
514 "Attributes"
515 ],
516 "members": {
517 "PlatformApplicationArn": {},
518 "Attributes": {
519 "shape": "Sj"
520 }
521 }
522 }
523 },
524 "SetSMSAttributes": {
525 "input": {
526 "type": "structure",
527 "required": [
528 "attributes"
529 ],
530 "members": {
531 "attributes": {
532 "shape": "Sj"
533 }
534 }
535 },
536 "output": {
537 "resultWrapper": "SetSMSAttributesResult",
538 "type": "structure",
539 "members": {}
540 }
541 },
542 "SetSubscriptionAttributes": {
543 "input": {
544 "type": "structure",
545 "required": [
546 "SubscriptionArn",
547 "AttributeName"
548 ],
549 "members": {
550 "SubscriptionArn": {},
551 "AttributeName": {},
552 "AttributeValue": {}
553 }
554 }
555 },
556 "SetTopicAttributes": {
557 "input": {
558 "type": "structure",
559 "required": [
560 "TopicArn",
561 "AttributeName"
562 ],
563 "members": {
564 "TopicArn": {},
565 "AttributeName": {},
566 "AttributeValue": {}
567 }
568 }
569 },
570 "Subscribe": {
571 "input": {
572 "type": "structure",
573 "required": [
574 "TopicArn",
575 "Protocol"
576 ],
577 "members": {
578 "TopicArn": {},
579 "Protocol": {},
580 "Endpoint": {},
581 "Attributes": {
582 "shape": "S15"
583 },
584 "ReturnSubscriptionArn": {
585 "type": "boolean"
586 }
587 }
588 },
589 "output": {
590 "resultWrapper": "SubscribeResult",
591 "type": "structure",
592 "members": {
593 "SubscriptionArn": {}
594 }
595 }
596 },
597 "Unsubscribe": {
598 "input": {
599 "type": "structure",
600 "required": [
601 "SubscriptionArn"
602 ],
603 "members": {
604 "SubscriptionArn": {}
605 }
606 }
607 }
608 },
609 "shapes": {
610 "Sj": {
611 "type": "map",
612 "key": {},
613 "value": {}
614 },
615 "Sp": {
616 "type": "map",
617 "key": {},
618 "value": {}
619 },
620 "S15": {
621 "type": "map",
622 "key": {},
623 "value": {}
624 },
625 "S1n": {
626 "type": "list",
627 "member": {
628 "type": "structure",
629 "members": {
630 "SubscriptionArn": {},
631 "Owner": {},
632 "Protocol": {},
633 "Endpoint": {},
634 "TopicArn": {}
635 }
636 }
637 }
638 }
639}
\No newline at end of file